write a dedicated readme

.env.sample

@@ -0,0 +1,7 @@
+# Used internally for cookie session
+SESSION_SECRET=
+# Used for connecting with Github OAuth
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+# Used for caching and saving drafts
+REDIS_URL=

README.md

@@ -1,41 +1,32 @@
-# Welcome to Remix!
+![Fly Deploy](https://github.com/juandjara/pressunto/actions/workflows/main.yml/badge.svg)
+![PRs welcome](https://img.shields.io/badge/PRs-welcome-green)
 
-- [Remix Docs](https://remix.run/docs)
+# Pressunto
 
-## Fly Setup
+Pressunto is a content editor for GitHub that does not get in your way designed for managing markdown files in static websites. It aims the simplest editing experience you could hope for while preserving your original content structure.
 
-1. [Install `flyctl`](https://fly.io/docs/getting-started/installing-flyctl/)
+You can read more in the [Documentation](https://pressunto.fly.dev/docs)
 
-2. Sign up and log in to Fly
+## Running locally
 
-```sh
-flyctl auth signup
-```
+To run this project on your local device, there is two options.
 
-3. Setup Fly. It might ask if you want to deploy, say no since you haven't built the app yet.
+- You can use the provided Dockerfile (recommended for production)
+- You can run the project with npm installing the node_modules (recommended for development)
 
-```sh
-flyctl launch
-```
+The project requires the following environment variables to be configured:
 
-## Development
+|Env var   |Description   |
+|---|---|
+|SESSION_SECRET   | A random long string. Used internally for cookie session  |
+|GITHUB_CLIENT_ID   | Client ID of your Github App. You can configure these in your [Github profile settings](https://github.com/settings/developers)   |
+|GITHUB_CLIENT_SECRET   | Client Secret of your Github App  |
+|REDIS_URL   | A working Redis URL. Used for caching and saving drafts  |
 
-From your terminal:
+A sample `.env.example` is provided with these keys blank. You can copy this file to a `.env` file if you intend to run locally with npm. When running locally, the dev server will read this file and load environment variables from the `.env` file.
 
-```sh
-npm run dev
-```
+## Contributing
 
-This starts your app in development mode, rebuilding assets on file changes.
+To contribute to this project, create a fork under your name, write you changes to a branch with a name relating your changes and send a Pull Request. You can read a more detailed guide [here](https://github.com/MarcDiethelm/contributing/blob/master/README.md).
 
-## Deployment
-
-If you've followed the setup instructions already, all you need to do is run this:
-
-```sh
-npm run deploy
-```
-
-You can run `flyctl info` to get the url and ip address of your server.
-
-Check out the [fly docs](https://fly.io/docs/getting-started/node/) for more information.
+Changes to the linter configuration and other architectural details and preferences (tabs, spaces, semicolons) won't be accepted without a strong argument but every PR will be read and discussed.