Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
✨ updated documentation (#66)
✨ updated documentation
  • Loading branch information
ApoorvSaxena committed Oct 15, 2017
1 parent 1b723fc commit ca736fd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -7,6 +7,9 @@ Use your best judgment, and feel free to propose changes to this document in a p

## How can I contribute?

### Using Lozad.js?
Share with us, and we'll mention it on the project homepage. When adding site to the *list of sites using Lozad.js*, please mention where to verify this in the PR description.

### Improve documentation

As a user of Lozad.js, you're the perfect candidate to help us improve our documentation. Typo corrections, error fixes, better explanations, more examples, etc. Open issues for things that could be improved. Anything. Even improvements to this document.
Expand All @@ -22,7 +25,7 @@ We're always looking for more opinions on discussions in the issue tracker. It's
## Reporting Issues

- Found a problem? Want a new feature? First of all see if your issue or idea has [already been reported](https://github.com/ApoorvSaxena/lozad.js/issues).
- If don't, just open a [new clear and descriptive issue](https://github.com/ApoorvSaxena/lozad.js/issues/new).
- If not, just open a [new clear and descriptive issue](https://github.com/ApoorvSaxena/lozad.js/issues/new).
- Use a clear and descriptive title.
- Include as much information as possible: Steps to reproduce the issue, error message, Browser version, operating system, etc.
- The more time you put into an issue, the more we will.
Expand Down
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -141,9 +141,13 @@ Available in [latest browsers](http://caniuse.com/#feat=intersectionobserver). I

Checkout the [FAQ Wiki](https://github.com/ApoorvSaxena/lozad.js/wiki/Frequently-Asked-Questions) for some common gotchas to be aware of while using **lozad.js**

## Sites using Lozad.js

* *[Add your site]* - See [Contributing section](./CONTRIBUTING.md)

## Support Lozad.js

Lozad.js is completely free and open-source. If you find it useful, you can show your support by sharing it in your social network or by simply letting me know how much you 💖 it by tweeting to [@Apoorv_Saxena](https://twitter.com/Apoorv_Saxena).
Lozad.js is completely free and open-source. If you find it useful, you can show your support by starring it or sharing it in your social network or by simply letting me know how much you 💖 it by tweeting to [@Apoorv_Saxena](https://twitter.com/Apoorv_Saxena).

## Contribute

Expand Down

0 comments on commit ca736fd

Please sign in to comment.