Skip to content

Commit cf9e727

Browse files
committed
Updated docs
1 parent f1ca006 commit cf9e727

4 files changed

Lines changed: 118 additions & 10 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ node_modules
66
*.env
77
.DS_Store
88
package-lock.json
9+
.bloggify/*

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015-19 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
3+
Copyright (c) 2015-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 115 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,44 @@
11
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
22

33

4+
5+
6+
7+
8+
9+
410
[![gridly](http://i.imgur.com/kPrOESX.png)](http://ionicabizau.github.io/gridly/example/)
511

12+
13+
14+
15+
16+
17+
18+
19+
20+
21+
622
# gridly
723

824
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/gridly.svg)](https://www.npmjs.com/package/gridly) [![Downloads](https://img.shields.io/npm/dt/gridly.svg)](https://www.npmjs.com/package/gridly) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
925

1026
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
1127

28+
29+
30+
31+
32+
33+
1234
> The minimal (~100-170 bytes) grid system for modern browsers.
1335
1436

37+
38+
39+
40+
41+
1542
You don't need monolithic CSS frameworks for simple grid systems. ~100 bytes of CSS can save your life. :dizzy:
1643

1744
## Usage
@@ -69,8 +96,19 @@ Then you can use the `.row` and `.col` classes:
6996
This will create two columns having equal widths.
7097

7198

99+
100+
101+
102+
103+
72104
[![gridly](http://i.imgur.com/m4pwrnO.png)](http://ionicabizau.github.io/gridly/example/)
73105

106+
107+
108+
109+
110+
111+
74112
## :cloud: Installation
75113

76114

@@ -87,6 +125,40 @@ yarn add gridly
87125
```
88126

89127

128+
129+
130+
131+
132+
133+
134+
135+
136+
137+
138+
139+
140+
141+
142+
143+
144+
145+
146+
147+
148+
## :question: Get Help
149+
150+
There are few ways to get help:
151+
152+
153+
154+
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
155+
2. For bug reports and feature requests, open issues. :bug:
156+
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
157+
158+
159+
160+
161+
90162
## :memo: Documentation
91163

92164

@@ -113,12 +185,22 @@ To extend this basic functionality, there is another file: `gridly-col-widths.mi
113185
Like specified above, the `gridly.min.css` contains both: the core and the custom widths.
114186

115187

188+
189+
190+
191+
192+
193+
194+
195+
196+
197+
198+
116199
## :yum: How to contribute
117200
Have an idea? Found a bug? See [how to contribute][contributing].
118201

119202

120203
## :sparkling_heart: Support my projects
121-
122204
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
123205
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
124206

@@ -138,35 +220,60 @@ Thanks! :heart:
138220

139221

140222

223+
224+
141225
Run `npm i` to install the dependencies. Then, you can run the npm scripts using `npm run <script-name>`.
142226

143227

144228
Run `npm run release` to recreate all the `dist` files.
145229

146230

231+
232+
233+
234+
235+
236+
237+
238+
239+
240+
241+
242+
147243
## :dizzy: Where is this library used?
148244
If you are using this library in one of your projects, add it in this list. :sparkles:
149245

150246

151-
152247
- [showalicense.com](http://showalicense.com/)–A site to provide an easy way to show licenses and their human-readable explanations. ([source](https://github.com/IonicaBizau/showalicense.com))
153248

154249

250+
251+
252+
253+
254+
255+
256+
257+
258+
259+
155260
## :scroll: License
156261

157262
[MIT][license] © [Ionică Bizău][website]
158263

159264

265+
266+
267+
268+
269+
[license]: /LICENSE
270+
[website]: https://ionicabizau.net
271+
[contributing]: /CONTRIBUTING.md
272+
[docs]: /DOCUMENTATION.md
160273
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
161274
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
162275
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
163276
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
164-
165277
[patreon]: https://www.patreon.com/ionicabizau
166278
[amazon]: http://amzn.eu/hRo9sIZ
167279
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
168-
169-
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
170-
[website]: https://ionicabizau.net
171-
[contributing]: /CONTRIBUTING.md
172-
[docs]: /DOCUMENTATION.md

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,4 +186,4 @@
186186
"bloggify.json",
187187
"bloggify/"
188188
]
189-
}
189+
}

0 commit comments

Comments
 (0)