Commit 3ab5635
Changed files (1)
README.md
@@ -68,6 +68,27 @@ If you want to contribute a badge:
- Add your badge to the [index.ts](./src/all-badges/index.ts) file.
- Any badge images are welcome (png, 256x256px).
+### How to test locally?
+
+Build project with next command:
+
+```sh
+npm run build
+```
+
+Run main.js with next command:
+
+```sh
+node dist/main.js your-username
+```
+
+This command will collect your data and save it to `data/your-username.json` file.
+You can skip recollecting the data with `--data` flag.
+
+```sh
+node dist/main.js your-username --data data/your-username.json
+```
+
## License
[MIT](LICENSE)