commit d7fbc2f1d86db423328aede0f64b4ff46a5efaed
Author: realaravinth <realaravinth@batsense.net>
Date:   Fri Feb 11 17:41:54 2022 +0530

    add readme

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d900800
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+<div align="center">
+<h1> Gists </h1>
+<p>
+
+**Self-Hosted GitHub Gists\***
+
+</p>
+
+[![Build](https://github.com/realaravinth/gists/actions/workflows/linux.yml/badge.svg)](https://github.com/realaravinth/gists/actions/workflows/linux.yml)
+[![dependency status](https://deps.rs/repo/github/realaravinth/gists/status.svg)](https://deps.rs/repo/github/realaravinth/gists)
+[![codecov](https://codecov.io/gh/realaravinth/gists/branch/master/graph/badge.svg)](https://codecov.io/gh/realaravinth/gists)
+
+</div>
+
+## Features
+
+-   [ ] Upload code snippets
+-   [ ] Syntax Highlighting
+-   [ ] Comments
+-   [ ] Versioning through Git
+-   [ ] Fork gists
+-   [ ] Gist privacy: public, unlisted, private
+-   [ ] Activity Pub implementation for publishing native gists and commenting
+
+## Why?
+
+Gists are nice, while there are wonderful forges like
+[Gitea](https://gitea.io), there isn't a libre pastebin implementation that
+can rival GitHub Gists.
+
+## Usage
+
+1. All configuration is done through
+   [./config/default.toml](./config/default.toml)(can be moved to
+   `/etc/static-gists/config.toml`).