Skip to content

Commit ea1028c

Browse files
Tadas TamosauskasTadas Tamosauskas
authored andcommitted
Replace React Starterify readme with own
1 parent 5a9d075 commit ea1028c

File tree

1 file changed

+5
-29
lines changed

1 file changed

+5
-29
lines changed

README.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,14 @@
1-
[![Build Status](https://travis-ci.org/Granze/react-starterify.svg?branch=master)](https://travis-ci.org/Granze/react-starterify)
2-
[![bitHound Score](https://www.bithound.io/github/Granze/react-starterify/badges/score.svg)](https://www.bithound.io/github/Granze/react-starterify/master)
3-
[![Dependency status](https://david-dm.org/granze/react-starterify/status.svg)](https://david-dm.org/granze/react-starterify "Dependency status")
4-
[![Dev dependency status](https://david-dm.org/granze/react-starterify/dev-status.svg)](https://david-dm.org/granze/react-starterify#info=devDependencies "Dev dependency status")
1+
# [{json:api}](https://jsonapi.org) document viewer.
52

6-
# React Starterify
3+
The flat {json:api} structure is a good way to express complex, sometimes circular relationships between objects in your API responses. However the same flatness makes it difficult for humans to "parse" these relationships. This project aims to visualise object relationships by visually nesting them.
74

8-
A minimal React JS application starter kit.
5+
This is a very much work in progress project: it lacks some essential features and has some crucial bugs.
96

10-
## Start small, add what you need.
11-
12-
React Starterify aims to give you a good starting point for your projects.
13-
If you're looking for a minimal ES6 (ES2015) React JS starter with nice [shallow rendering](https://facebook.github.io/react/docs/test-utils.html#shallow-rendering) test examples, this is probably for you.
14-
15-
## Why there are no Flux or Isomorphic things inside?
16-
17-
If you are a beginner, you probably don't want a complex structure with lots of things to care about.
18-
If you are an advanced user, and you need more features, you can choose one of the thousand existing full-stack starter kit. Or you can build your own.
7+
Built using [React Starterify](https://github.com/Granze/react-starterify).
198

209
## Usage
2110

22-
[Download React Starterify](https://github.com/Granze/react-starterify/releases/latest)
11+
Clone this project `git clone https://github.com/tadast/json-api-document-viewer.git && cd json-api-document-viewer`
2312

2413
__Install the dependencies:__
2514

@@ -41,19 +30,6 @@ __Deploy on Github pages with one command:__
4130

4231
`npm run deploy`
4332

44-
## What's new in v2.0:
45-
46-
- React Router integration
47-
- CSS processing via [PostCSS](https://github.com/postcss/postcss)
48-
- cssnano for minification
49-
- nested
50-
- extend
51-
- vars
52-
- autoprefixer
53-
- gulpfile written in ES6 (ES2015)
54-
- better folder structure
55-
- no predefined AJAX libraries (use [Fetch](https://github.com/github/fetch) or [Superagent](https://github.com/visionmedia/superagent) if you need one).
56-
5733
## License
5834

5935
[MIT License](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)