@@ -14,22 +14,22 @@ In order to respond to a need expressed by the community, I create an encycloped
1414** Download** : [ All versions are available here] ( https://github.com/raczak/crawlit-dofus-encyclopedia-parser/releases )
1515
1616
17- ** :warning : Don't use the tool for more than 20 pages per hour**
17+ ** :warning : Don't use the tool for more than 700 items per hour** (for Dofus-Touch).
1818
19- Crawlit was built to be very light full , it can run on almost every configurations.
19+ Crawlit was built to be very light, it can run on almost every configurations.
2020
2121In fact Crawlit is a tool :
2222
2323- Developed by the dofus community, for the community
24- - ** 100% performance** : Developed to be very light full
24+ - ** 100% performance** : Developed to be very light
2525- Simple to use | Plug and use
26- - Resume parsing feature after 429 error (too many request )
26+ - Resume parsing feature after errors (connection off / 429 error / ... )
2727- App packaged into ** executable** , no need to install something
2828- English & French encyclopedia supported (french item & english item)
2929
3030App launched | App at the end
3131:-------------------------:|:-------------------------:
32- ![ ] ( https://raw.githubusercontent.com/raczak/crawlit-dofus-encyclopedia-parser/master/assets/crawlit1.JPG ) | ![ ] ( https://raw.githubusercontent.com/raczak/crawlit-dofus-encyclopedia-parser/master/assets/crawlit6.JPG )
32+ ![ ] ( https://raw.githubusercontent.com/raczak/crawlit-dofus-encyclopedia-parser/master/assets/crawlit_API.gif ) | ![ ] ( https://raw.githubusercontent.com/raczak/crawlit-dofus-encyclopedia-parser/master/assets/crawlit6.JPG )
3333
3434## JSON files also provided in the repository
3535In case you wan't directly the dofus JSON files, I oftenly upload up-to-date encyclopedia JSON in the ` data/ ` folder.
@@ -55,8 +55,32 @@ An item result example
5555}
5656```
5757
58- ## App usage example
59- ![ ] ( https://raw.githubusercontent.com/raczak/crawlit-dofus-encyclopedia-parser/master/assets/crawlit_API.gif )
58+ ## Getting Started
59+
60+ Clone & access this repository locally :
61+
62+ ``` bash
63+ git clone https://github.com/raczak/crawlit-dofus-encyclopedia-parser.git
64+ cd crawlit-dofus-encyclopedia-parser
65+ ```
66+
67+ Install dependencies with npm :
68+
69+ ``` bash
70+ npm install
71+ ```
72+
73+ ** :warning : There is an issue with ` npm start ` on some CLI, in this case prefere use ` node lib/app.js ` .**
74+
75+ ### [ Optional] To build packaged app
76+
77+ If you want to generate packaged app (executable) with ` pkg ` dependency, you ** MUST** install ` zeit/pkg ` in npm global context.
78+ Please follow [ Pkg documentation] ( https://github.com/zeit/pkg ) for troubleshooting.
79+
80+ ``` bash
81+ npm install -g pkg
82+ ```
83+ - ** in a terminal window** -> ` npm run pkg-all `
6084
6185## Supported items
6286| Items | state of progress |
0 commit comments