diff options
author | 2022-11-19 13:57:59 -0800 | |
---|---|---|
committer | 2022-11-19 13:57:59 -0800 | |
commit | 52b5cb70ec6aaa058d306c9916bcb851f2311730 (patch) | |
tree | 81cc811d1d2636fb47afb5784efa6fd50c78d5ac /README.md | |
parent | e75a5433a98ce51c1fe1633ee5344879c01e7fb7 (diff) | |
download | notion-52b5cb70ec6aaa058d306c9916bcb851f2311730.tar.gz notion-52b5cb70ec6aaa058d306c9916bcb851f2311730.tar.zst notion-52b5cb70ec6aaa058d306c9916bcb851f2311730.zip |
chore(docs+deps): Update dependencies, update docs to discuss contributing and tests
Diffstat (limited to '')
-rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
@@ -7,8 +7,32 @@ Notion API client library for rust. This project is under active development and this README will be updated as this library gets closer to a reliable state. However, if you're really eager see the example todo cli application provided in [examples/todo](examples/todo). +## Docs + +The generated documentation site is available here: https://docs.rs/notion/ + ## Building ```bash cargo build ``` + +### Pull Request builds + + + +## Testing + +We are in the process of moving to [wiremock](https://docs.rs/wiremock/latest/wiremock/) based notion api testing. +Existing tests use a private notion org, and expect an environment variable set of `NOTION_API_TOKEN`. + +We understand that right now this is a bit painful, but any help in this migration journey is very welcome! + +## Contributing + +Contributions are always welcome! +If you have an idea, it's best to float it by us before working on it to ensure no effort is wasted. +If there's already an open issue for it, knock yourself out. + +If you have any questions, feel free to use [Discussions](https://github.com/jakeswenson/notion/discussions). +Please don't hesitate to ask questions! |