Skip to content

Commit b9da519

Browse files
committed
Restore SDK documentation files (README, CHANGELOG, CONTRIBUTING, GUIDE)
These were accidentally deleted in previous commit. The SDK documentation is essential for users to understand how to use the zeroentropy-community crate.
1 parent b2ed575 commit b9da519

File tree

4 files changed

+886
-0
lines changed

4 files changed

+886
-0
lines changed

CHANGELOG.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.1] - 2025-11-10
9+
10+
### Changed
11+
- Updated repository URL in Cargo.toml
12+
- Improved documentation and examples
13+
14+
## [0.1.0] - 2025-11-08
15+
16+
### Added
17+
- Initial release of ZeroEntropy Rust SDK
18+
- Complete implementation of ZeroEntropy API endpoints
19+
- Collections API (create, list, delete)
20+
- Documents API (add text/PDF, get info, update, delete)
21+
- Queries API (top documents, top snippets, top pages)
22+
- Reranking API
23+
- Async client built on Tokio and reqwest
24+
- Configurable retry logic with exponential backoff
25+
- Strong typing with comprehensive error handling
26+
- Builder pattern for client configuration
27+
- Support for metadata filtering
28+
- PDF document support
29+
- Examples: basic usage and arXiv search
30+
- Complete API documentation
31+
- Apache 2.0 license
32+
33+
[0.1.1]: https://github.com/davidatoms/zeroentropy-rust/compare/v0.1.0...v0.1.1
34+
[0.1.0]: https://github.com/davidatoms/zeroentropy-rust/releases/tag/v0.1.0

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contributing to ZeroEntropy Rust SDK
2+
3+
Thank you for your interest in contributing to the ZeroEntropy Rust SDK! We welcome contributions from the community.
4+
5+
## Getting Started
6+
7+
1. Fork the repository on GitHub
8+
2. Clone your fork locally
9+
3. Create a new branch for your feature or bugfix
10+
4. Make your changes
11+
5. Run tests to ensure everything works
12+
6. Submit a pull request
13+
14+
## Development Setup
15+
16+
```bash
17+
# Clone the repository
18+
git clone https://github.com/davidatoms/zeroentropy-rust.git
19+
cd zeroentropy-rust
20+
21+
# Build the project
22+
cargo build
23+
24+
# Run tests
25+
cargo test
26+
27+
# Run examples (requires API key)
28+
export ZEROENTROPY_API_KEY="your-api-key"
29+
cargo run --example basic
30+
```
31+
32+
## Code Style
33+
34+
- Follow standard Rust conventions and idioms
35+
- Use `cargo fmt` to format your code
36+
- Run `cargo clippy` to catch common mistakes
37+
- Write clear, descriptive commit messages
38+
39+
## Testing
40+
41+
- Add tests for new functionality
42+
- Ensure all existing tests pass
43+
- Test your changes with real API calls when possible
44+
45+
## Pull Request Process
46+
47+
1. Update the README.md with details of changes if applicable
48+
2. Update the CHANGELOG.md with your changes
49+
3. Ensure your code builds and all tests pass
50+
4. The PR will be reviewed by maintainers
51+
5. Once approved, your changes will be merged
52+
53+
## Reporting Issues
54+
55+
When reporting issues, please include:
56+
57+
- A clear, descriptive title
58+
- Steps to reproduce the issue
59+
- Expected behavior
60+
- Actual behavior
61+
- Your environment (OS, Rust version, SDK version)
62+
- Any relevant error messages or logs
63+
64+
## Code of Conduct
65+
66+
- Be respectful and inclusive
67+
- Welcome newcomers and help them learn
68+
- Focus on constructive feedback
69+
- Maintain professionalism
70+
71+
## Questions?
72+
73+
If you have questions about contributing, feel free to:
74+
75+
- Open an issue for discussion
76+
- Contact the maintainers at founders@zeroentropy.dev
77+
78+
## License
79+
80+
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.

0 commit comments

Comments
 (0)