Improve documentation

This commit is contained in:
Joakim Hellsén 2024-02-13 07:05:15 +01:00
commit 19938091fa
7 changed files with 129 additions and 5 deletions

View file

@ -8,12 +8,11 @@ FeedVault is an open-source web application written in Golang that allows users
_Note: Some features are currently in development._
- **Unified Feed Archiving**: Archive RSS, Atom, and JSON feeds seamlessly in one centralized location.
- **Unified Feed Archiving**: Archive RSS (0.90 to 2.0), Atom (0.3, 1.0), and JSON (1.0, 1.1) feeds seamlessly in one centralized location.
- **Content Search**: Easily search your archive for specific content.
- **Export Options**: Export your archive to various formats, including JSON, CSV, HTML, ODS, RST, TSV, XLS, XLSX, or YAML.
- **API**: Access your archive programmatically through a API.
- **Self-Hosting**: Host FeedVault on your own server for complete control over your data.
- **User-Friendly Design**: FeedVault is designed to be simple, intuitive, and responsive, working seamlessly on both desktop and mobile devices.
- **Privacy-Focused**: FeedVault respects user privacy by not tracking or collecting any personal data. It is an ad-free platform that prioritizes user security.
## Usage
@ -23,9 +22,15 @@ _Note: Some features are currently in development._
- Add your favorite feeds to start archiving content.
- Explore, manage, and enjoy your centralized feed archive.
## Docker
Please see [Docker.md](Docker.md).
## Contributing
We welcome contributions from the community! If you have ideas for new features, improvements, or bug fixes, feel free to open an issue or submit a pull request.
All contributions are welcome regardless of skill level or experience.
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on how to contribute to FeedVault.
## Contact