Skip to content
Snippets Groups Projects
Commit 42b7a4f8 authored by Tomasz Ducin's avatar Tomasz Ducin
Browse files

readme files moved

parent d31d6286
Branches
Tags
No related merge requests found
UPCOMING: UPCOMING:
changes: changes:
- faker and chance are not longer required as dependencies - faker and chance are not longer required as dependencies
v0.3.2
date: ?
changes:
- unit tests added
v0.3.1
date: 2016-04-15
changes:
- several bugfixes
- brief architecture overview added
v0.3.0 v0.3.0
date: 2016-04-07 date: 2016-04-07
changes: changes:
......
...@@ -40,7 +40,7 @@ Use [JSON Schema](http://json-schema.org/) along with fake generators to provide ...@@ -40,7 +40,7 @@ Use [JSON Schema](http://json-schema.org/) along with fake generators to provide
- [Grunt plugin](#grunt-plugin) - [Grunt plugin](#grunt-plugin)
- Misc - Misc
- [Contribution](#contribution) - [Contribution](#contribution)
- [Architecture](#architecture) - [Technical Documentation](#technical-documentation)
- [Resources](#resources) - [Resources](#resources)
- [Motivation](#motivation) - [Motivation](#motivation)
...@@ -450,9 +450,11 @@ to automate running `json-schema-faker` against your JSON schemas. ...@@ -450,9 +450,11 @@ to automate running `json-schema-faker` against your JSON schemas.
We are more than happy to welcome new contributors, our project is heavily developed, but we need more power :) We are more than happy to welcome new contributors, our project is heavily developed, but we need more power :)
Please see [contribution guide](CONTRIBUTING.md), you can always contact us to ask how you can help. Please see [contribution guide](CONTRIBUTING.md), you can always contact us to ask how you can help.
### Architecture ### Technical Documentation
If you want to contribute, take a look at [the architecture page](ARCHITECTURE.md). You may find some important information there making it easier to start. If you want to contribute, take a look at [the technical documentation page](docs/). You may find some important information there making it easier to start.
Moreover, if you find something unclear (e.g. how does something work) or would like to suggest improving the docs, please submit an issue, we'll gladly provide more info for future contributors.
## Resources ## Resources
......
## Table of Contents
* [Architecture](#architecture)
* [Sources](#sources)
* [Building](#building)
* [Testing](#testing)
# Architecture # Architecture
![JSON Schema Faker module graph](structure.png) ![JSON Schema Faker module graph](structure.png)
...@@ -44,3 +51,7 @@ Compile typescript to javascript: ...@@ -44,3 +51,7 @@ Compile typescript to javascript:
Build package files: Build package files:
./build/dist.js ./build/dist.js
# Testing
Detailed description of test [can be found here](../spec).
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
# unit tests # unit tests
location: [`spec/unit`](spec/unit) location: [`spec/unit`](unit)
Typical unit tests, low-level. Using `jasmine` under `jasmine-node`. Each *spec* file loads a js unit using node.js `require` function and fires assertions against it. That's all. Typical unit tests, low-level. Using `jasmine` under `jasmine-node`. Each *spec* file loads a js unit using node.js `require` function and fires assertions against it. That's all.
...@@ -15,7 +15,7 @@ Typical unit tests, low-level. Using `jasmine` under `jasmine-node`. Each *spec* ...@@ -15,7 +15,7 @@ Typical unit tests, low-level. Using `jasmine` under `jasmine-node`. Each *spec*
# schema tests # schema tests
location: [`spec/schema`](spec/schema) location: [`spec/schema`](schema)
Kind of functional tests, high-level - executing the whole `jsf` engine to generate fake data against given JSON Schema and checking the quality of the results. Kind of functional tests, high-level - executing the whole `jsf` engine to generate fake data against given JSON Schema and checking the quality of the results.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment