Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent 01f1afd commit 53797e1
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 3 deletions.
105 changes: 104 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,52 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


















# rucksack-lite

[![Version](https://img.shields.io/npm/v/rucksack-lite.svg)](https://www.npmjs.com/package/rucksack-lite) [![Downloads](https://img.shields.io/npm/dt/rucksack-lite.svg)](https://www.npmjs.com/package/rucksack-lite)







> The base class for the Rucksack JavaScript and CSS bundler.





For bundling, use [`rucksack`](https://github.com/Bloggify/rucksack).












## :cloud: Installation

```sh
Expand All @@ -20,6 +58,17 @@ yarn add rucksack-lite
```













## :clipboard: Example


Expand Down Expand Up @@ -51,16 +100,25 @@ console.log(bundler.html())









## :question: Get Help

There are few ways to get help:



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.
2. For bug reports and feature requests, open issues. :bug:





## :memo: Documentation


Expand Down Expand Up @@ -146,16 +204,61 @@ Generates the HTML for both CSS and JS assets. Optionally, a custom array can be














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `bloggify`
- `rucksack`











## :scroll: License

[MIT][license] © [Bloggify][website]

[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2014#license-mit





[license]: /LICENSE
[website]: https://bloggify.org
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@
"dependencies": {
"url-remote": "^1.1.8"
}
}
}

0 comments on commit 53797e1

Please sign in to comment.