Adding the example directory

Author: khalidx

README.md

@@ -21,7 +21,7 @@ Deploy an API to the cloud **in under 30 seconds**, *in just 3 steps*.
 
 ![tutorial](./tutorial.gif)
 
-1) Build your domain objects as JSON Schemas, all in the same Markdown document. Alternatively, run `rx init` to get a [ready-to-use document](./sample.md) with two sample schemas.
+1) Build your domain objects as JSON Schemas, all in the same Markdown document. Alternatively, run `rx init` to get a [ready-to-use document](./example/sample.md) with two sample schemas.
 
 2) When you run `rx generate sample.md`, you'll get a full CRUD (create-read-update-delete) Swagger specification for your API.
 

example/contacts.md

@@ -0,0 +1,20 @@
+# The Contacts API
+
+Here's how a contact should be defined:
+
+```yaml
+contact:
+  type: object
+  required:
+    - name
+  properties:
+    name:
+      type: string
+      description: The contact's full name
+    email:
+      type: string
+      description: The contact's email address
+    phone:
+      type: string
+      description: The contact's phone number
+```

sample.md renamed to example/sample.md

@@ -27,7 +27,7 @@
     "/lib",
     "/npm-shrinkwrap.json",
     "/oclif.manifest.json",
-    "sample.md"
+    "/example/sample.md"
   ],
   "engines": {
     "node": ">=8.0.0"

package.json

@@ -9,7 +9,7 @@ import { log } from './log'
  */
 export const init = async (directory: string): Promise<void> => {
   // Get the sample document (this is read from the assets directory in the final bundle)
-  let document = await fse.readFile(path.join(__dirname, '../../../sample.md'))
+  let document = await fse.readFile(path.join(__dirname, '../../../example/sample.md'))
   // Write the document to the specified directory
   await fse.writeFile(path.join(directory, 'sample.md'), document)
   log('success', 'Created the ./sample.md file successfully.')

src/library/cli/init.ts

@@ -14,7 +14,7 @@ import {
 let document: string
 
 test.before(async t => {
-  let file = path.join(__dirname, '../../sample.md')
+  let file = path.join(__dirname, '../../example/sample.md')
   document = (await fse.readFile(file)).toString()
 })