rascunho

commit 4c97a173f8ff6fbb85b0076d9c496e8f41502292

Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>

Update readme

 README-en.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md | 4 ++++


diff --git a/README-en.md b/README-en.md
new file mode 100644
index 0000000000000000000000000000000000000000..eb07395d2288468b3d42fc6591bc1e3040682f03
--- /dev/null
+++ b/README-en.md
@@ -0,0 +1,51 @@
+# Rascunho
+
+A small project to preview markdown notes.
+
+This project allows you to submit a text in the markdown format and
+preview the note, with no tracking and no ads. It will also generate
+a link so you can share the note around.
+
+There's also a very basic API so you can create notes using a POST
+request to the endpoint at `/api/v1`.
+
+## Infra
+
+The documentation about the ops is available at the repo
+[rascunho-etc][rascunho-etc]. There you'll find a [openrc
+service][openrc] and a nginx configuration.
+
+There's a instance deployed at [eletrotupi.com][eletrotupi] where is
+using PostgreSQL and being served with nginx, but you can use whatever
+kind of database compatible with SQLAlchemy like `mysql` or `sqlite`.
+
+[eletrotupi]: https://eletrotupi.com
+[openrc]: https://wiki.gentoo.org/wiki/OpenRC
+[rascunho-etc]: https://git.sr.ht/~porcellis/rascunho-etc
+
+## Running
+
+Install the dependencies using your distro package manager, namely
+`sqlalchemy`, `flask`, `humanize`, `dateutil`, `mistune` and serve with
+a reverse-proxy (like nginx).
+
+## API
+
+There's is a pretty basic API, here's a sample using `curl (1)`:
+
+```sh
+curl -X POST \
+  'https://rascunho-instance.com/api/v1' \
+  -H 'Content-Type: application/json; charset=utf-8' \
+  -d '{"text": "# This is a test.\n\n Hello **world**." }'
+```
+
+## Contributing
+
+Send patches, start discussions and other things at my
+[public-inbox](mailto:~porcellis/public-inbox@lists.sr.ht).
+
+## License
+
+Source code available under the `GNU AGPL-3.0-or-later`, check the
+LICENSE file to more info.




diff --git a/README.md b/README.md
index 7c8fd60e381ca1ba089204af316010ca5ce2c6d6..347e799442587912c1721b38c7a82f796b519943 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # Rascunho
 
+> There's a english version of this [README][readme-en].
+
+[readme-en]: https://git.sr.ht/~porcellis/rascunho/tree/master/README-en.md
+
 Um projeto para visualizar anotações usando o formato de texto
 [markdown](https://porcellis.com/markdown).