add md files

fractalwrench · fractalwrench · commit b6dd5d43a58b · 2018-02-26T17:21:39.000Z
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+# Contributing
+
+Contributions are very welcome! It's worth searching 
+[open issues](https://github.com/fractalwrench/json-2-kotlin/issues) first to ensure that
+someone else isn't working on the problem.
+
+If you plan on adding substantial new functionality, please open an issue first for discussion.
+
+If you're interested in adding another option for source code generation, then the SourceBuildDelegate interface 
+should get you started with API hooks. You can add JSON input files and expected Kotlin output under
+ `test/resources/valid` - the parameterised test suite should automatically run these cases if they follow the 
+ naming conventions. 
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Json2Kotlin
+
+Documentation under construction &#128296;
diff --git a/TODO.md b/TODO.md
@@ -3,7 +3,7 @@
 
 Ordered roughly in priority:
 
-- Write Contributing guide
+- Write Readme
 - Add GH topics/description
 - Test command line tool
 - Make website tool prettier

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Json2Kotlin`
	`2`	`+`
	`3`	`+Documentation under construction 🔨`