chore: readme (#31)

* add images

* boilerplate readme

* improve readme

* improve readme header

* add link in header

* amend previous commit

* amend

* amend boxfish link

* improve readme

* improve readme

* sort header data

* improve readme

* extend readme

* improve readme

* improve readme

* improve readme

* improve

README.md

@@ -1,2 +1,107 @@
-# spl-token-faucet
-Generic Solana spl-token faucet webapp
+<h1 align="center">
+  <br>
+  <a href="https://boxfish.studio"><img src="doc/img/gh-splash.png" title="Fontana. By Boxfish Studio"></a>
+</h1>
+
+<h1 align="center">Fontana</h1>
+
+<p align="center">
+<a href="https://fontana.boxfish.studio/">fontana.boxfish.studio</a>
+</p>
+
+<p align="center">A simple dashboard to manage Solana SPL tokens</p>
+
+
+<p align="center">
+  <a aria-label="build status" href="https://github.com/boxfish-studio/fontana/actions/workflows/deploy_prod.yaml">
+    <img alt="" src="https://github.com/boxfish-studio/fontana/actions/workflows/deploy_prod.yaml/badge.svg">
+  </a>
+  <a aria-label="contributors graph" href="https://github.com/boxfish-studio/fontana/graphs/contributors">
+    <img alt="" src="https://img.shields.io/github/contributors/boxfish-studio/fontana.svg">
+  </a>
+  <a aria-label="last commit" href="https://github.com/boxfish-studio/fontana/commits/main">
+    <img alt="" src="https://img.shields.io/github/last-commit/boxfish-studio/fontana.svg">
+  </a>
+  <a aria-label="license" href="https://github.com/boxfish-studio/fontana/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/boxfish-studio/fontana.svg" alt="">
+  </a>
+</p>
+
+---
+
+## Features
+
+- Create, mint, and transfer SPL tokens
+- Mainnet and devnet support
+- Configurable RPCs
+- Compatible with Phantom, Solflare, Torus, Sollet, Glow and Slope wallets
+- 2 different operation modes: wallet-based and server-based
+
+
+## Using the program
+
+### Wallet-based mode
+
+This mode is only operational when a wallet is connected.
+
+When using this mode, the creation, minting and transfer of tokens will be performed by the connected wallet account.
+The displayed available tokens will be the ones belonging to the wallet account plus the ones available in server mode.
+
+### Server-based mode
+
+This mode is only operational when no wallet is connected.
+
+When using this mode, the creation, minting and transfer of tokens is performed by a account configured in the server.
+Newly created tokens will be stored in a dedicated database. The displayed tokens will be those configured within the application config file, plus the later added tokens found in the database.
+
+When using mainnet with this mode, the creation of new tokens is not enabled by default, since it would require for an account with real funds configured in the server.
+
+## Run 
+
+Clone the repo, and run the development server:
+
+```bash
+yarn dev 
+```
+
+The app will open at [http://localhost:3000](http://localhost:3000).
+
+
+## Configuration
+
+The app needs the following environment variables:
+
+```
+ NEXT_PUBLIC_RPC_API_DEVNET = Url of your preferred devnet RPC
+ NEXT_PUBLIC_RPC_API_MAINNET = Url of your preferred mainnet RPC
+ NEXT_PUBLIC_DATABASE_URL = Url of your mongodb cluster (for data persistance)
+```
+
+Then additionally, if you want to configure the app to manage certain tokens by default, you need to configure them in the [config file](fontana.config.ts) and add the corresponding environment variables.
+
+```
+const config: Config[] = [
+  {
+    keypair: "WALLET_1",
+    owner: "Token owner public account",
+    token: "Token mint account",
+    network: "Devnet" or "Mainnet",
+  }
+];
+```
+
+Which will require for a new environment variable `NEXT_PUBLIC_WALLET_1` corresponding to the `WALLET_1` keypair. 
+
+```
+ NEXT_PUBLIC_WALLET_1 = [Private key for token owner account]
+```
+
+You will need to add as many new environment variables as wallet ids are used in your configuration file.
+
+## License
+
+[Apache 2.0](./LICENSE) &copy; [Boxfish Studio]
+
+
+[Boxfish Studio]: https://boxfish.studio
+