Merge pull request #26 from maj/readme-tweaks

Tweaks to README, CONTRIBUTING md files

Contributing.md

-# Contributing to Adobe Cloud Platform XDM Machinery
+# Contributing to Adobe Cloud Platform JSON Schema Markdown Tools
 
-The XDM Machinery project is an Open Development/Inner Source project and welcomes contributions from everyone at Adobe.
+This project is an Open Development/Inner Source project and welcomes contributions from everyone at Adobe.
 
 ## Things to Keep in Mind
 
-The XDM Machinery project uses a **commit then review** process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others.
+This project uses a **commit then review** process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others.
 
 For other contributors, a maintainer of the project has to approve the pull request.
 
@@ -12,22 +12,21 @@ For other contributors, a maintainer of the project has to approve the pull requ
 
 * Check that there is an [existing issue](https://jira.corp.adobe.com/issues/?jql=project%20%3D%20ACP%20AND%20component%20in%20(%22machinery%22)) in the ACP project
 * Check if there are other pull requests that might overlap or conflict with your intended contribution
-* If there is no issue, and no prior work, send a short mail to [Grp-XDM-API-WGs](mailto:Grp-XDM-API-WGs@adobe.com) with the subject line `[XDM][Machinery] Contribution …`
+* If there is no issue, and no prior work, send a short mail to [Grp-XDM-API-WGs](mailto:Grp-XDM-API-WGs@adobe.com) with the subject line `[XDM][JSONSchema2MD] Contribution …`
 
 # How to Contribute
 
 1. Fork the repository
-2. Create a pull request
-3. Submit the pull request
+2. Make some changes on a branch on your fork
+3. Create a pull request from your branch
 
-In your pull request, outline,
+In your pull request, outline:
 
-* What the change intends to do
-* How it changes the existing code
-* If (and what) it breaks
+* What the changes intend
+* How they change the existing code
+* If (and what) they breaks (TODO: we should have tests instead. pst: working on that ;) )
 * Start the pull request with the JIRA issue ID, e.g. ACP-123
 
-
 Each commit message:
 
 * Should contain the issue ID like `[ACP-123]`
@@ -35,10 +34,10 @@ Each commit message:
 
 ## Coding Styleguides
 
-There are no coding style guides yet.
+There are no coding style guides... yet.
 
 # How Contributions get Reviewed
 
 One of the maintainers will look at the pull request within one week. If you haven't heard back from the maintainers within a week, it is not impolite to send a reminder to [Grp-XDM-API-WGs](mailto:Grp-XDM-API-WGs@adobe.com).
 
-Feedback on the pull request will be given in writing, in GitHub.
\ No newline at end of file
+Feedback on the pull request will be given in writing, in GitHub.

README.md

 # JSON Schema Markdown Tools
 
-Documenting and validating complex JSON Schemas can be hard. This tool maks it easier by providing a number of scripts that can turn JSON Schema files into readable Markdown documenation that is ready to be read on GitHub, or processed using Jekyll or other static site generators.
+Documenting and validating complex JSON Schemas can be hard. This tool maks it easier by providing a number of scripts that can turn JSON Schema files into readable Markdown documenation that is ready for consumption on GitHub or processed using Jekyll or other static site generators.
 
 These tools have been introduced by Adobe to document Adobe's Experience Data Models (XDM), but can be used for other JSON Schema documents, too.
 
@@ -11,14 +11,14 @@ These tools have been introduced by Adobe to document Adobe's Experience Data Mo
 ## Installing and running
 
 ```bash
-# clone models project
-$ git clone git@git.corp.adobe.com:AdobeCloudPlatform/models.git
+# clone XDM project
+$ git clone git@git.corp.adobe.com:AdobeCloudPlatform/xdm.git
 
-# clone machinery project
-$ git clone git@git.corp.adobe.com:AdobeCloudPlatform/machinery.git
+# clone this project
+$ git clone git@git.corp.adobe.com:AdobeCloudPlatform/jsonschema2md.git
 
 # install dependencies
-$ cd machinery && npm install
+$ cd jsonschema2md && npm install
 
 # show usage information
 $ node index.js
@@ -28,15 +28,15 @@ $ node index.js
 # Usage: node index.js
 #
 # Options:
-#   -d, --input   path to directory containing all JSON Schemas or a single JSON Schema file. This will be considered as the baseURL  [required]
-#   -f, --isFile  pass if input is a single file path
-#   -o, --out   path to output directory (default: ./out)
-#   -x, --schema-out  pass to output JSON Schema files including description and validated examples in the _new folder at output directory
-#   -s, --metaSchema pass it followed by path to Custom meta schema to validate other schemas
-
+#   -d, --input       path to directory containing all JSON Schemas or a single JSON Schema file. This will be considered as the baseURL  [required]
+#   -f, --isFile      pass if input is a single file path
+#   -o, --out         path to output directory (default: ./out)
+#   -m, --meta        add metadata elements to .md files Eg -m template=reference. Multiple values can be added by repeating the flag Eg: -m template=reference -m hide-nav=true
+#   -x, --schema-out  output JSON Schema files including description and validated examples in the _new folder at output directory
+#   -s, --metaSchema  path to Custom meta schema to validate other schemas
 
 # run task
- node index.js -d ../models/schemas/draft-04/
+$ node index.js -d ../xdm/schemas/draft-04/
 # generated output for whole folder is written to ./out
 ```
 
@@ -56,11 +56,10 @@ You can conveniently use the JSON Schema Markdown Tools from `npm`. This makes i
 
 ```json
   "devDependencies": {
-    "adobecloudplatform-machinery": "git+ssh://git@git.corp.adobe.com:AdobeCloudPlatform/machinery.git"
+    "jsonschema2md": "git+ssh://git@git.corp.adobe.com:AdobeCloudPlatform/jsonschema2md.git"
   }
 ```
 
-
 Then add the following to the `"scripts"` section of your `package.json` and adapt accordingly:
 
 ```json
@@ -76,7 +75,7 @@ If you run `npm install` before running `npm run prepare`, `npm` will install th
 * JSON Schema validation:
   * property naming convention
   * vocabulary spellchecking
-* …
+* Tests
 
 ## Contributing