From a57980bd926d24fadbaadb6f0a08157323626a24 Mon Sep 17 00:00:00 2001
From: Alexander Lang <alex@upstre.am>
Date: Tue, 22 Oct 2019 17:01:26 +0200
Subject: [PATCH] add readme

---
 LICENSE   | 19 +++++++++++++++++++
 README.md | 25 +++++++++++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..7142486
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2019 Alexander Lang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f2fdf0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# CouchDB GitHub Action
+
+This [GitHub Action](https://github.com/features/actions) sets up a CouchDB database.
+
+# Usage
+
+See [action.yml](action.yml) and [test.yml](.github/workflows/test.yml).
+
+Basic:
+```yaml
+steps:
+  - name: Set up CouchDB
+    id: couchdb
+    uses: "cobot/couchdb-action@master"
+    with:
+      couchdb version: '2.3.1'
+  - name: Do something
+    run: |
+      curl http://${{steps.couchdb.outputs.ip}}:5984/
+
+```
+
+# License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)