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 38cd7a3 commit 84d865a
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 2 deletions.
97 changes: 96 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. -->


















# olx-api

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







> A module to access the OLX API resources.





For API documentation, check out the developer pages: https://developer.olx.ro/ro












## :cloud: Installation

```sh
Expand All @@ -20,6 +58,17 @@ yarn add olx-api
```













## :clipboard: Example


Expand Down Expand Up @@ -65,16 +114,25 @@ client.getTokens("client_credentials").then(() => {









## :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 @@ -126,16 +184,53 @@ Make a GET request.














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
























## :scroll: License

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

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





[license]: /LICENSE
[website]: https://bloggify.org
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@
"blah": {
"description": "For API documentation, check out the developer pages: https://developer.olx.ro/ro"
}
}
}

0 comments on commit 84d865a

Please sign in to comment.