Create README.md

README.md

@@ -0,0 +1,30 @@
+# actual-rest-api
+
+Expose [Actual](https://actualbudget.org/) data via plain old HTTP rest APIs without the need of using the JS SDK or querying the SQLite3 DB.
+
+> ⚠️ This app is in its early stage, without tests, versioning, or docs. Bad things will happen if you use it! ⚠️
+
+## Running
+
+```shell
+git clone https://github.com/acifani/actual-rest-api.git
+pnpm install
+pnpm build
+```
+
+Some environment variables are required, you can find them in `.env.example`.
+You can create an `.env` file or export them to your shell manually.
+
+```shell
+# Use native nodejs .env loader (requires v20.6.0+)
+node --env-file=.env ./dist/index.js
+
+# or export them on your shell however you want
+export FINECO_USER_ID=12345678
+export ...
+
+node ./dist/index.js
+```
+
+There's also a Docker image available in the 
+[Packages](https://github.com/acifani/actual-rest-api/pkgs/container/actual-rest-api) section of this repo.