# HG changeset patch
# User Christophe de Vienne <christophe@cdevienne.info>
# Date 1600447834 -7200
#      Fri Sep 18 18:50:34 2020 +0200
# Node ID 4d5b4bc0b176818d92367edd13e28c0bb98df338
# Parent  0ebc121e41cae9c86ca4f9b1d0d83efb6d54ec90
Add a basic README

diff --git a/README.md b/README.md
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Go Orus API
+
+<meta name="go-import" content="golang.org/x/tools hg https://orus.io/orus-io/go-orusapi">
+
+Go Orus API is a library, a set of [go-swagger](https://goswagger.io) templates and
+a few code generation tools for easy implementation of a REST API based on a
+[swagger 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)
+description file.
+
+It uses a chosen set of tools, one for each need:
+
+- [zerolog](https://github.com/rs/zerolog) for fast and beautiful logging
+- [Postgresql](https://www.postgresql.org/) for storing the data, with the help
+  of:
+
+  * [lib/pq](https://github.com/lib/pq) as the database driver, soon to be
+    replaced with [pgx](https://github.com/jackc/pgx)
+  * [squirrel](https://github.com/Masterminds/squirrel) for safely writing SQL
+
+- [sentry](https://sentry.io/) exports for monitoring errors
+- [prometheus](https://prometheus.io/) metrics
+- [go-swagger](https://goswagger.io) for generating most the server files