Skip to content

Commit 86d3cab

Browse files
committed
fix(README): add screenshot
1 parent 6e5de36 commit 86d3cab

1 file changed

Lines changed: 3 additions & 50 deletions

File tree

README.md

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,8 @@
1-
# Pristine Typescript React
1+
# json-schema-to-react-tree
22

3-
A typescript open source repository in its original condition. It leverages Typescript and React to give a good starting point for new and existing projects.
3+
A react component to visually display JSON Schemas
44

5-
Pristine Typescript React a fork of [Pristine](https://github.com/etclabscore/pristine).
6-
7-
There are a lack of repositories to start from to build community driven open source projects. Pristine Typescript is a complete starting point, it follows a Documentation Driven Development approach, and can be used as a resource to augment existing documentation.
8-
9-
## How to use Pristine in your project
10-
11-
There are 3 options for using pristine with your project.
12-
1. Fork this repo as the start of your own, OR
13-
2. [follow these instructions](https://thoughts.t37.net/merging-2-different-git-repositories-without-losing-your-history-de7a06bba804) to use it on an existing repository.
14-
3. Use the `Use this template` button on this repository.
15-
16-
## Documentation Driven Development
17-
18-
There are many ways to drive open source development. Documenting the problem in the README gives a middle ground between technical and non-technical specifications. This allows organizing solutions to this challenge around community and documentation.
19-
20-
> [...] a beautifully crafted library with no documentation is also damn near worthless. If your software solves the wrong problem or nobody can figure out how to use it, there’s something very bad going on.
21-
22-
- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html) by Tom Preson-Werner
23-
24-
### Conventions and Specifications
25-
26-
This repository has some strong opinions built in like circleci, semantic-release, npm. So feel free to fork and change it at your own discretion. It is only meant to be a starting point. That being said:
27-
28-
Using conventions, documentation and specifications make it easier to:
29-
- communicate the problem you are solving
30-
- ease onboarding
31-
- build and use composable tools
32-
- promote open source contribution and engagement
33-
- promote issue and feature discussion on Github itself
34-
35-
#### Resources
36-
37-
- [Pristine](https://github.com/etclabscore/pristine)
38-
- [opensource.guide](https://opensource.guide/)
39-
- [Github community profiles for public repositories](https://help.github.com/articles/about-community-profiles-for-public-repositories/)
40-
- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
41-
- [pengwynn/flint](https://github.com/pengwynn/flint)
42-
- [Working Backwards](https://www.allthingsdistributed.com/2006/11/working_backwards.html)
43-
- [Literate programming](https://en.wikipedia.org/wiki/Literate_programming)
44-
- [Hammock Driven Development](https://www.youtube.com/watch?v=f84n5oFoZBc)
45-
- [Inversion and The Power of Avoiding Stupidity](https://fs.blog/2013/10/inversion/)
46-
- [choosealicense.com](http://choosealicense.com)
47-
48-
## Getting Started
49-
50-
To get started, [fork](https://help.github.com/articles/fork-a-repo/) or [duplicate](https://help.github.com/articles/duplicating-a-repository/) the repository. Then edit this file and delete everything above this line.
51-
52-
Then edit the `package.json` and change the `name` and `homepage` fields to match your newly created repository.
5+
![image](https://user-images.githubusercontent.com/364566/78063975-dfa08c80-7345-11ea-8afe-103771392d1b.png)
536

547
### Contributing
558

0 commit comments

Comments
 (0)