| 1 | # **:triangular_flag_on_post: TWIT-STREAM** (version 1.0.0)
|
| 2 |
|
| 3 |
|
| 4 | > Streaming from v2 twitter API
|
| 5 |
|
| 6 | ---
|
| 7 |
|
| 8 | ## **Documentation**
|
| 9 | - [API Documentation](https://crunchwrapsupreme.github.io/twit-stream-v2/index.html)
|
| 10 |
|
| 11 | ---
|
| 12 |
|
| 13 | ## **:package: Main tools used**
|
| 14 |
|
| 15 | - [x] axios
|
| 16 |
|
| 17 | ---
|
| 18 |
|
| 19 | ## **:wrench: Developer usage**
|
| 20 |
|
| 21 | - [x] eslint
|
| 22 | - [x] mocha
|
| 23 | - [x] jsdoc
|
| 24 | - [x] docdash
|
| 25 |
|
| 26 | ### **Set up project**
|
| 27 |
|
| 28 | - Choose a folder project in your system and switch in `cd [folder path]`
|
| 29 | - Clone the repo in your folder path
|
| 30 |
|
| 31 | ---
|
| 32 |
|
| 33 | ### **Installation**
|
| 34 |
|
| 35 | In order to install the project and all dependencies, enter in the project folder and run `npm install`
|
| 36 |
|
| 37 | ---
|
| 38 |
|
| 39 | ### Test the project
|
| 40 |
|
| 41 | ```bash
|
| 42 | npm test
|
| 43 | ```
|
| 44 |
|
| 45 | ---
|
| 46 |
|
| 47 |
|
| 48 | ## **:handshake: Contributing**
|
| 49 |
|
| 50 | - Fork it!
|
| 51 | - Create your feature branch: `git checkout -b my-new-feature`
|
| 52 | - Commit your changes: `git commit -am 'Add some feature'`
|
| 53 | - Push to the branch: `git push origin my-new-feature`
|
| 54 | - Submit a pull request
|
| 55 |
|
| 56 | ---
|
| 57 |
|
| 58 |
|
| 59 |
|
| 60 | ### **:heart: Show your support**
|
| 61 |
|
| 62 | Please :star: this repository if you like it or this project helped you!\
|
| 63 | Feel free to open issues or submit pull-requests to help me improving my work.
|
| 64 |
|
| 65 |
|
| 66 | ---
|
| 67 |
|
| 68 | ### **:robot: Author**
|
| 69 |
|
| 70 | _*David Young*_
|
| 71 |
|
| 72 |
|
| 73 | ---
|
| 74 |
|
| 75 | Copyright © 2020 David Young
|