Skip to content

Commit 08e7697

Browse files
authored
Add README
1 parent 0e8beba commit 08e7697

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Raven Python Library
2+
3+
[![pypi](https://img.shields.io/pypi/v/ravendev.svg)](https://pypi.python.org/pypi/ravendev)
4+
5+
6+
## Documentation
7+
8+
API documentation is available at <https://docs.ravenapp.dev/introduction>.
9+
10+
## Installation
11+
12+
Add this dependency to your project's build file:
13+
14+
```bash
15+
pip install ravendev
16+
# or
17+
poetry add ravendev
18+
```
19+
20+
## Beta status
21+
22+
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your build.gradle file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
23+
24+
## Contributing
25+
26+
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest [opening an issue](https://github.com/ravenappdev/raven-java) first to discuss with us!
27+
28+
On the other hand, contributions to the README are always very welcome!

0 commit comments

Comments
 (0)