README.md: initial project description

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a7a933
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Future me - a distributed git based bug tracker
+
+## About
+
+As the main git forges forces you to create accounts I wanted to create a
+simple bug tracker solution for my own git server. I liked the idea of
+using git notes feature as git-appraise uses for distributed pull requests
+and found git-bug interesting. But my idea don't fit into git-bug or
+git-appraise. Therefore I started creating this project.
+
+### Current status
+
+Nothing to see right now^(tm).
+
+## License
+
+SPDX MIT see [LICENSE](LICENSE) for more information.
+
+## References
+
+* [git-bug](https://github.com/git-bug/git-bug)
+* [git-appraise](https://github.com/google/git-appraise)
+
+## Contribution
+
+This project follows the "git email flow". If there is interest in this project
+I will create a dedicated mailing list for it. But for now feel free to send me
+a git format-patch style patch with git send-email to
+[Bernhard.Guillon@begu.org]