From 42b7a4f87f779d5316f3a9d614b1ad49bf340d78 Mon Sep 17 00:00:00 2001 From: Tomasz Ducin <tomasz.ducin@gmail.com> Date: Tue, 19 Apr 2016 22:13:52 +0200 Subject: [PATCH] readme files moved --- CHANGELOG.md | 9 +++++++++ README.md | 8 +++++--- docs/README.md | 11 +++++++++++ spec/README.md | 4 ++-- 4 files changed, 27 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f389d0e..ecb34b77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,15 @@ UPCOMING: changes: - 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 date: 2016-04-07 changes: diff --git a/README.md b/README.md index 951b12c5..3d9bd35f 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Use [JSON Schema](http://json-schema.org/) along with fake generators to provide - [Grunt plugin](#grunt-plugin) - Misc - [Contribution](#contribution) - - [Architecture](#architecture) + - [Technical Documentation](#technical-documentation) - [Resources](#resources) - [Motivation](#motivation) @@ -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 :) 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 diff --git a/docs/README.md b/docs/README.md index a4f94c0f..7bc96755 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,10 @@ +## Table of Contents + +* [Architecture](#architecture) +* [Sources](#sources) +* [Building](#building) +* [Testing](#testing) + # Architecture  @@ -44,3 +51,7 @@ Compile typescript to javascript: Build package files: ./build/dist.js + +# Testing + +Detailed description of test [can be found here](../spec). diff --git a/spec/README.md b/spec/README.md index 3fbe9577..36994b4a 100644 --- a/spec/README.md +++ b/spec/README.md @@ -7,7 +7,7 @@ # 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. @@ -15,7 +15,7 @@ Typical unit tests, low-level. Using `jasmine` under `jasmine-node`. Each *spec* # 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. -- GitLab