From: Adam Dullage <redacted>
Date: Fri, 12 May 2023 17:48:34 +0000 (+0100)
Subject: Updated README
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=70c32f77cbdae750dd15b4f7245bdf703d6ca9d9;p=flatnotes.git

Updated README
---

diff --git a/README.md b/README.md
index a7b75b0..4054b7e 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,27 @@
 ![Logo](docs/logo.svg)
 
-A self-hosted, database-less note taking web app that utilises a flat folder of markdown files for storage.
+A self-hosted, database-less note-taking web app that utilises a flat folder of markdown files for storage.
 
 Log into the [demo site](https://demo.flatnotes.io) and take a look around. *Note: This site resets every 15 minutes.*
 
+## Contents
+
+* [Design Principle](#design-principle)
+* [Features](#features)
+* [Getting Started](#getting-started)
+  * [Hosted](#hosted)
+  * [Self Hosted](#self-hosted)
+* [Roadmap](#roadmap)
+* [Sponsorship](#sponsorship)
+* [Thanks](#thanks)
 
 ## Design Principle
 
-flatnotes is designed to be a distraction free note taking app that puts your note content first. This means:
+flatnotes is designed to be a distraction-free note-taking app that puts your note content first. This means:
 
 * A clean and simple user interface.
 * No folders, notebooks or anything like that. Just all of your notes, backed by powerful search and tagging functionality.
-* Quick access to a full text search from anywhere in the app (keyboard shortcut "/").
+* Quick access to a full-text search from anywhere in the app (keyboard shortcut "/").
 
 Another key design principle is not to take your notes hostage. Your notes are just markdown files. There's no database, proprietary formatting, complicated folder structures or anything like that. You're free at any point to just move the files elsewhere and use another app.
 
@@ -27,11 +37,20 @@ Equally, the only thing flatnotes caches is the search index and that's incremen
 * Multiple authentication options (none, username/password, 2FA).
 * Restful API.
 
-See [the wiki](https://github.com/Dullage/flatnotes/wiki) for more details.
+See [the wiki](https://github.com/dullage/flatnotes/wiki) for more details.
+
+## Getting Started
+
+### Hosted
+
+A quick and easy way to get started with flatnotes is to host it on PikaPods. Just click the button below and follow the instructions.
+
+[![PikaPods](https://www.pikapods.com/static/run-button-34.svg)](https://www.pikapods.com/pods?run=flatnotes)
+
 
-## Installation
+### Self Hosted
 
-The easiest way to install flatnotes is using Docker.
+If you'd prefer to host flatnotes yourself then the recommendation is to use Docker.
 
 ### Example Docker Run Command
 
@@ -77,7 +96,7 @@ See the [Environment Variables](https://github.com/Dullage/flatnotes/wiki/Enviro
 
 ## Roadmap
 
-I want to keep flatnotes as simple and distraction free as possible which means limiting new features. This said, I welcome feedback and suggestions.
+I want to keep flatnotes as simple and distraction-free as possible which means limiting new features. This said, I welcome feedback and suggestions.
 
 One feature I do plan to implement is the ability to *share* a note. In the spirit of simple and database-less, the current plan is to generate temporary pre-signed URLs but this needs to be explored.
 
@@ -91,7 +110,7 @@ If you find this project useful, please consider buying me a beer. It would genu
 
 ## Thanks
 
-A special thanks to 2 fantastic open source projects that make flatnotes possible.
+A special thanks to 2 fantastic open-source projects that make flatnotes possible.
 
 * [Whoosh](https://whoosh.readthedocs.io/en/latest/intro.html) - A fast, pure Python search engine library.
 * [TOAST UI Editor](https://ui.toast.com/tui-editor) - A GFM Markdown and WYSIWYG editor for the browser.