update docs

Author: brianleroux

doc/spec.md

@@ -5,11 +5,13 @@ Goals
 # Structure with Pragmas
 
 # Scalar Values
-- String
-- Number
-- Boolean
+
+- string
+- number
+- boolean
 
 # Collection Values
 
-- Map
-- Vector
+- array
+- vector
+- map

examples/arc.arc

@@ -15,6 +15,12 @@ fingerprint true
 
 @http
 get /
+post /login
+post /logout
+post /posts
+patch /posts/:postID
+delete /posts/:postID
+get /posts/:postID
 
 @ws
 join

readme.md

@@ -9,11 +9,9 @@ The format:
 - Comments follow `#` symbols
 - Starts with a `@pragma`
 - Pragmas start with `@`
-- Pragmas contain either scalar values, `Array`, `Vector` or `Map`
-- Scalar values are either `String`, `Number` or `Boolean`
-- `Array` values are space seperated scalar values on a single line
-- `Vector` is a named array with newline seperated scalar values 
-- `Map` is defined by a scalar value followed by vectors indented two spaces
+- Pragmas contain; scalar values or complex values
+- Scalar values are: `string`, `number` and `boolean`
+- Complex values are: `array`, `vector` and `map`
 
 ## Example
 
@@ -27,10 +25,16 @@ another-value
 4.2 # Number
 true # Boolean
 
-@another-section-of-vectors
+@section-of-arrays
 vector of values
 vector tuple
 
+@vectors-section
+named
+  vector
+  of
+  values
+
 @this-section-has-a-map
 hello-world
   name some-value
@@ -58,10 +62,13 @@ Prints the following plain object to the console:
     4.2,
     true
   ],
-  "another-section-of-vectors": [
+  "section-of-arrays": [
     ["vector", "of", "values"],
     ["vector", "tuple"]
   ],
+  "vectors-section": [
+    {named: ["vector", "of", "values"]},
+  ],
   "this-section-has-a-map": [{
     "hello-world": {
       "name": "some-value"
@@ -70,4 +77,10 @@ Prints the following plain object to the console:
 }
 ```
 
+Things to notice:
+
+- `array` values are space seperated scalar values on a single line
+- `vector` is a named `array` with scalar values indented two spaces on newlines
+- `map` is a named value followed by keys and values indented two spaces
+
 [npm]: https://www.npmjs.com/package/@architect/parser

src/compat/arc.js

@@ -0,0 +1,3 @@
+module.exports = function arc(code) {
+  return parse(lex(code), schema)
+}

src/index.js

@@ -1,3 +1,4 @@
+let arc = require('./compat/arc')
 let json = require('./compat/json')
 let yaml = require('./compat/yaml')
 let stringify = require('./compat/stringify')
@@ -12,6 +13,7 @@ function parse(code) {
   return parser(lex(code))
 }
 
+parse.arc = arc
 parse.json = json
 parse.yaml = yaml
 parse.stringify = stringify