From 56b24ff9c5dd2b08906d05a9503dfa95b93a0cf9 Mon Sep 17 00:00:00 2001 From: JW Jacobson <116485484+jwjacobson@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:00:34 -0500 Subject: [PATCH] Expand README --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/README.md b/README.md index e69de29..8935516 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,64 @@ +# Private Facts + +Private Facts is a web app to track your private info. + +[//]: # (Tahoe Logo) + + +[//]: # (Badges: Build status, UV, Python version, Downloads) + + +#### Why private facts? + +The project intends to be a demonstration of how to use [Tahoe-lafs]() "provider independent privacy". + +## Installation + +#### Install from source + +```bash +git clone https://github.com/blaisep/private_facts.git && cd private_facts +``` + +#### Install from (Docker) Image + +TBA + +#### + +```bash +a bash code block +``` + +## Usage + +### Run using a (OCI) container + + +```python +A Python code block +``` + +## Feedback + +The project issue tracker is getting migrated. For now, feel free to open an issue and let us know how how to improve. + + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first +to discuss what you would like to change. + +### Set up the developer environment + +### Getting ready for your first pull request + +Please make sure to update tests as appropriate. + +We Manage the project with [uv](https://docs.astral.sh/uv/), you don't have to. + +## License + +[MIT](https://choosealicense.com/licenses/mit/) + +[//]: # ( This file was inspired by https://www.makeareadme.com/ )