summaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorJannis R <mail@jannisr.de>2020-05-01 23:21:22 +0200
committerJannis R <mail@jannisr.de>2020-05-02 16:35:49 +0200
commitfff4d0666f44781a7998174dbc700322f496676d (patch)
tree359d72b5dcc4c12c60881c9fd4c3076f3d6c3849 /readme.md
init
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..4a2c50b
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,29 @@
+# gemini
+
+**An experimental [Gemini](https://gemini.circumlunar.space) server.**
+
+[![npm version](https://img.shields.io/npm/v/@derhuerst/gemini.svg)](https://www.npmjs.com/package/@derhuerst/gemini)
+[![build status](https://api.travis-ci.org/derhuerst/gemini.svg?branch=master)](https://travis-ci.org/derhuerst/gemini)
+![ISC-licensed](https://img.shields.io/github/license/derhuerst/gemini.svg)
+![minimum Node.js version](https://img.shields.io/node/v/@derhuerst/gemini.svg)
+[![chat with me on Gitter](https://img.shields.io/badge/chat%20with%20me-on%20gitter-512e92.svg)](https://gitter.im/derhuerst)
+[![support me on Patreon](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg)](https://patreon.com/derhuerst)
+
+
+## Installation
+
+```shell
+npm install @derhuerst/gemini
+```
+
+
+## Usage
+
+```js
+todo
+```
+
+
+## Contributing
+
+If you have a question or need support using `gemini`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, use [the issues page](https://github.com/derhuerst/gemini/issues).