Skip to content

Commit

Permalink
chore(version bump): release v0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
alexnm committed Apr 3, 2019
1 parent 1497948 commit 5a3d18d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 17 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="https://github.com/teleporthq/teleport-code-generators/blob/master/Default.png" width="250"/>
</p>

<h2 align="center">Code Generators v0.4 - Alpha!</h2>
<h2 align="center">Code Generators v0.5 - Alpha!</h2>

<h3 align="center">
<a href="#what">What</a>
Expand Down Expand Up @@ -201,21 +201,7 @@ Besides the regular files and folders generated at the end of the process, proje
* Creating the entry point for each application (it can be an `index.html` or something that is framework specific)
* Generating a web manifest for PWA support

### UIDL Validators

The package also exports a module that performs UIDL validations for any given JSON structure, based on the [JSON Schema](link coming soon).

```javascript
import { UIDLValidators } from '@teleporthq/teleport-code-generators'

const componentUIDL = { ... }
const projectUIDL = { ... }

UIDLValidators.validateComponent(componentUIDL) // true / error object
UIDLValidators.validateProject(projectUIDL) // true / error object
```

When the validation fails, an **error** object is returned. Validation is performed using [https://github.com/epoberezkin/ajv](a standard JSON schema validator).
Full documentation coming soon.

### Further Reading
A few useful links to get you up to speed with the entire **teleport** ecosystem:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@teleporthq/teleport-code-generators",
"version": "0.4.1",
"version": "0.5.0",
"description": "Code generators and UIDL definition library",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 5a3d18d

Please sign in to comment.