✨ Release, docs, and examples

README.md

@@ -19,7 +19,7 @@ npm install jsonresume-theme-microdata
 
 ## How is this theme different than `jsonresume-theme-even`?
 
-**note: this resume should replicate [rbardini's `even` theme][even-theme].**
+**note: this resume should replicate the styling from [rbardini's `even` theme][even-theme].**
 
 ### microdata
 
@@ -31,7 +31,7 @@ To learn more, see the article [Make your resume SEO friendly using JSON Resume
 
 Extra properties were added to support control of the final structured data output on some content types. For instance, in the `Work` HTML, the default designation for an employer is the Type `Organization`, but [schema.org/Organization](https://schema.org/Organization) has a lot of specific subTypes like `Corporation` or `WorkersUnion` - each with their own sub-data.
 
-See the Options below for how to add them to your resume.json.
+See the Options below for how to add `themeOptions` and use the `microdata` properties to your resume.json.
 
 ### HTML changes
 
@@ -54,6 +54,10 @@ npm install resumed jsonresume-theme-microdata
 npx resumed render --theme jsonresume-theme-microdata
 ```
 
+**validator note** `resumed` includes the [resume-schema validator](https://github.com/jsonresume/resume-schema). This validator will validate against [the canonical JSON Resume schema.json](https://github.com/jsonresume/resume-schema/blob/master/schema.json), but the validation will not be validating the `microdata` additions across the types.
+
+**validation tip:** to validate your `resume.json` content against the [jsonresume-theme-microdata's schema.json](./schema.json), you can use an online tool like [Hyperjump's JSON Schema validator](https://json-schema.hyperjump.io/).
+
 ### Standalone usage
 
 Carried over by forking _Even_, this repo comes with a barebones CLI that reads resumes from `stdin` and outputs HTML to `stdout`. This allows usage without any resume builder tools:

examples/with-jsonresume-theme/README.md

@@ -2,7 +2,7 @@
 
 This example shows how to use Resumed with a JSON Resume theme, [microdata](https://github.com/scottnath/jsonresume-theme-microdata).
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/scottnath/jsonresume-theme-microdata/tree/article/examples/with-jsonresume-theme?file=README.md)
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/scottnath/jsonresume-theme-microdata/tree/main/examples/with-jsonresume-theme?file=README.md)
 
 ## How to use