Create README.md

Author: ReeceM

README.md

@@ -0,0 +1,38 @@
+# custom-type-api
+
+API library to interface with the Custom Types and Slices API for Prismic
+
+## Important
+
+I have intentionally only implemented mainly support for node as I don't see the need to have this ability to interact with the API available client side.
+
+### WIP, please add issues or comments if there is anything that you see :)
+
+The readme is a WIP and the code could probably have some error handling added.
+
+## Example
+
+Below is an example of how to use this to interact with the API for the custom types, it gets a type and writes the result to ta json file.
+
+```js
+let Api = require('./dist/index').default;
+let credentials = require('./env.json');
+let fs = require('fs');
+let path = require('path')
+let api = new Api('slicemachine-startup', credentials.token)
+
+async function test() {
+  await api.login()
+
+  try {
+    let response = await api.types().getOne('page');
+    let res = await response.json();
+    console.log(res)
+    fs.writeFileSync(path.join(__dirname, 'page.json'), JSON.stringify(res, null, 2))
+  } catch (ex) {
+    console.error(ex)
+  }
+}
+
+test()
+```