Skip to content

Commit 16eaa72

Browse files
committed
Made the Documentation more Clear...
1 parent 3529c1e commit 16eaa72

File tree

1 file changed

+75
-6
lines changed

1 file changed

+75
-6
lines changed

README.md

Lines changed: 75 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# QUERIES
2-
### A Simple npm package for using responsive media screen sizes in your web app.
3-
# Now a Easier way to use media queries in your Web App.
2+
3+
## A Simple npm package for using responsive media screen sizes in your web app.
4+
## Now a Easier way to use media queries in your
45
- Easy to use
56
- Media screen sizes are completely made accurate for devices
67
- Make your website Responsive to all devices
@@ -18,11 +19,11 @@ yarn add queries
1819
NOTE: This can be only done using ``styled components``.
1920
## React App
2021
### Example
21-
```
22+
```js
2223
import React from "react";
2324
import styled from "styled-components";
2425
import { Colors } from "apple-colors";
25-
import QUERIES from "queries";
26+
import QUERIES from "responsive-web";
2627

2728
const Wrapper = styled.div`
2829
height: 300px;
@@ -62,7 +63,7 @@ const MyDeviceQuery = () => (
6263

6364
## Vue App
6465
You need to install ``vue-styled-components``
65-
```
66+
```js
6667
<template>
6768
<Wrapper>
6869
<Header>
@@ -72,6 +73,7 @@ You need to install ``vue-styled-components``
7273
</template>
7374
<script>
7475
import styled from "vue-styled-components";
76+
import QUERIES from "responsive-web";
7577

7678
const Wrapper = styled.div`
7779
height: 300px;
@@ -100,4 +102,71 @@ export default {
100102
}
101103
}
102104
</script>
103-
```
105+
```
106+
107+
## Available Sizes
108+
### Default:
109+
- MOBILE
110+
- TABLET
111+
- LAPTOP
112+
- DESKTOP
113+
- TV
114+
### You could Access these properties by: `QUERIES.OBJECTDEFINEDABOVE`
115+
116+
## Cusom Device Sizes
117+
## IOS:
118+
- FOUR (iPhone 4 Models)
119+
- LANDSCAPE
120+
- PORTRAIT
121+
- FIVE (iPhone 5 to 7 Models)
122+
- LANDSCAPE
123+
- PORTRAIT
124+
- EIGHT (iPhone 8 Models, excluding plus models)
125+
- LANDSCAPE
126+
- PORTRAIT
127+
- PLUS (iPhone 7 and 8 PLUS)
128+
- LANDSCAPE
129+
- PORTRAIT
130+
- X (iPhone X Models)
131+
- LANDSCAPE
132+
- PORTRAIT
133+
134+
## SAMSUNG:
135+
- S3 (Also contains Note4 and Note5 Models Too.)
136+
- LANDSCAPE
137+
- PORTRAIT
138+
- NOTE3
139+
- LANDSCAPE
140+
- PORTRAIT
141+
- S6
142+
- LANDSCAPE
143+
- PORTRAIT
144+
145+
## TABLETS:
146+
- IPAD
147+
- MINI (This contains iPad 1, 2, Mini and Air too.)
148+
- LANDSCAPE
149+
- PORTRAIT
150+
- IPAD4 (This contains iPad 3, 4 and iPad Pro 9.5" Models too.)
151+
- PORTRAIT
152+
- LANDSCAPE
153+
- PRO10
154+
- LANDSCAPE
155+
- PORTRAIT
156+
- PRO12
157+
- PORTRAIT
158+
- LANDSCAPE
159+
160+
161+
## LAPTOPS
162+
- NONRETINA (Devices which have non-retina display)
163+
- RETINA (Devices Which have Retina display)
164+
165+
# Developer
166+
Haneen Mahdin
167+
168+
Follow me on:
169+
- [Instagram](https://instagram.com/haneenmahdin)
170+
- [GitHub](https://github.com/haneenmahd)
171+
# License
172+
### `responsive-web` is licensed under MIT.

0 commit comments

Comments
 (0)