feat: add bare-minimum docs (#12)

syllogio · Aug 11, 2019 · 4b2ff63 · 4b2ff63
1 parent fbc60cf
commit 4b2ff63
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/CONSUMING.md b/CONSUMING.md
@@ -0,0 +1,3 @@
+# Consuming the API
+
+The API does not exist yet. Check back here for instructions on consuming the API once it exists.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Contributing
+
+## Installation
+
+Run `yarn` or `npm install`.
+
+## Running locally
+
+Run `yarn watch` or `npm run watch`.
diff --git a/README.md b/README.md
@@ -0,0 +1,6 @@
+# Syllogio API
+
+A GraphQL API for expressing and acting upon propositions and logical arguments.
+
+- [I am a developer interested in contributing to syllogio-api](./CONTRIBUTING.md)
+- [I am a client developer interested in consuming the API](./CONSUMING.md)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Consuming the API

		The API does not exist yet. Check back here for instructions on consuming the API once it exists.