aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3655257
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Exgit #
+
+Simple [Elixir][2] application for exploring [Git][1] repositories.
+
+This is very much a work in progress and a way to study Git internals.
+
+## Documentation ##
+
+[Hexdocs][3] hosts documentation for the project.
+
+## License ##
+
+This software is released, AS-IS and WITHOUT warranty, as free and open-source
+software with the hope it will be found useful under the terms and conditions
+of the [GNU General Public License, version 3][4] or later. For more
+information, please consult to provided `LICENSE` file.
+
+[1]: https://git-scm.com
+
+[2]: http://elixir-lang.org
+
+[3]: https://hexdocs.pm/exgit
+
+[4]: https://www.gnu.org/licenses/gpl.html