From d921cc3f4b2774521480c3dc4dec7c4f7fed9aa0 Mon Sep 17 00:00:00 2001
From: Artemy <artegoser@gmail.com>
Date: Wed, 19 Apr 2023 17:47:19 +0300
Subject: [PATCH] doc: readme file

---
 .github/FUNDING.yml |  3 +++
 README.md           | 39 +++++++++++++++++++++++++++++++++++++--
 2 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 .github/FUNDING.yml

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..083cbd3
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+custom:
+  - https://boosty.to/artegoser/donate
+  - https://www.donationalerts.com/r/artegoser
diff --git a/README.md b/README.md
index 54d33b5..474617b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
-# AnoPaper
- 
+# AnoPaper - Notes service
+
+AnoPaper is a notes service that allows you to save notes locally, complete notes using OpenAI API, collaborate on notes with other users and more. The notes supports markdown, MathJax, and GFM syntax.
+
+Running on: <https://anopaper.artegoser.ru/>
+
+## Features
+
+- Save notes locally
+- Publish one-time notes (when read, the note is deleted from the server and saved locally)
+- Use OpenAI API to complete notes (with your own api key)
+- Collaborate with other users on notes
+- Synchronize data across devices
+- Support markdown, MathJax, and GFM syntax
+
+## Local installation
+
+- Setup repository
+
+```bash
+git clone https://github.com/artegoser/AnoPaper.git
+npm install
+npm run build
+```
+
+- Create a .env file in the root directory of the project with the following environment variables:
+
+  - PORT: The port on which the server will listen.
+  - KEY: Secret key to encrypt notes on the server
+
+## Contributing
+
+Contributions are welcome! If you would like to contribute to this project, please create a pull request.
+
+## License
+
+This project is licensed under the GNU General Public License v3.0. See the LICENSE file for more information.