notion-rsync 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -2
- package/dist/cli.js +28 -25
- package/dist/cli.js.map +3 -3
- package/package.json +15 -3
package/README.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# notion-rsync
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/notion-rsync)
|
|
4
|
+
[](https://www.npmjs.com/package/notion-rsync)
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
|
|
3
7
|
One-way sync from Notion to local Markdown files. Fast, idempotent, and designed for docs-as-code workflows.
|
|
4
8
|
|
|
5
9
|
```bash
|
|
@@ -7,6 +11,8 @@ One-way sync from Notion to local Markdown files. Fast, idempotent, and designed
|
|
|
7
11
|
notion-rsync sync --output ./docs
|
|
8
12
|
```
|
|
9
13
|
|
|
14
|
+
**[npm](https://www.npmjs.com/package/notion-rsync)** | **[GitHub](https://github.com/nonfx/notion-sync)** | **[Issues](https://github.com/nonfx/notion-sync/issues)**
|
|
15
|
+
|
|
10
16
|
## Why?
|
|
11
17
|
|
|
12
18
|
- **Docs-as-code** - Keep your documentation in git, use your favorite editor, run CI/CD on it
|
|
@@ -216,12 +222,22 @@ bun run format
|
|
|
216
222
|
|
|
217
223
|
## Roadmap
|
|
218
224
|
|
|
225
|
+
- [x] Retry logic for rate limits
|
|
219
226
|
- [ ] Progress indicators
|
|
220
227
|
- [ ] Configuration file support
|
|
221
|
-
- [ ] Retry logic for rate limits
|
|
222
228
|
- [ ] Image downloading (optional)
|
|
223
229
|
- [ ] Two-way sync (future)
|
|
224
230
|
|
|
231
|
+
## Contributing
|
|
232
|
+
|
|
233
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
234
|
+
|
|
235
|
+
1. Fork the repository
|
|
236
|
+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
|
237
|
+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
|
|
238
|
+
4. Push to the branch (`git push origin feature/amazing-feature`)
|
|
239
|
+
5. Open a Pull Request
|
|
240
|
+
|
|
225
241
|
## License
|
|
226
242
|
|
|
227
|
-
MIT
|
|
243
|
+
MIT - see [LICENSE](LICENSE) for details.
|