fix: updated the readme which was from template, this closes etclabsc…

…ore#1

README.md

@@ -1,5 +1,30 @@
-# Pristine Typescript React Materal UI Monaco Playground
-
+<center>
+  <h3 align="center">Pristine Typescript React Materal UI Monaco Playground</h3>
+
+  <p align="center">
+    A modern and feature-rich Monaco playground template.
+    <br />
+    <a href="https://eserialize.com/">View Demo</a>
+    ·
+    <a href="https://github.com/etclabscore/pristine-typescript-react-material-ui-monaco-playground/issues/new?assignees=&labels=&template=bug_report.md&title=">Report Bug</a>
+    ·
+    <a href="https://github.com/etclabscore/pristine-typescript-react-material-ui-monaco-playground/issues/new?assignees=&labels=&template=feature_request.md&title=">Request Feature</a>
+  </p>
+</center>
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [About The Project](#about-the-project)
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+- [Usage](#usage)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+- [License](#license)
+- [Resources](#resources)
+
+<!-- about the project -->
+## About The Project
 An open source repository in its original condition. It leverages Typescript, React, Material UI theming, moment.js, i18next, and a monaco splitscreen to give a good starting point for new and existing projects.
 
 Pristine Typescript React Material UI is a fork of [Pristine](https://github.com/etclabscore/pristine).
@@ -8,33 +33,36 @@ There are a lack of repositories to start from to build community driven, multi-
 
 ![monaco-playground](https://user-images.githubusercontent.com/364566/67905556-f9d40580-fb2e-11e9-8410-6e55c1b614f0.gif)
 
-## How to use Pristine in your project
+## Getting Started
+
+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.
 
-There are 3 options for using pristine with your project.
-1. Fork this repo as the start of your own, OR
-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.
-3. Use the `Use this template` button on this repository.
+Then edit the `package.json` and change the `name` and `homepage` fields to match your newly created repository.
 
-## Documentation Driven Development
+### Installation
 
-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.
+Install project dependencies `npm install` and start it up `npm start`
 
-> [...] 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.
+## Usage
 
-- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html) by Tom Preson-Werner
+Projects utilizing _this_ template.
+- https://inspector.open-rpc.org/
+- https://playground.open-rpc.org/
+- https://eserialize.com/
 
-### Conventions and Specifications
+<!-- template just leave alone  -->
+## Roadmap
+See the [open issues](https://github.com/etclabscore/pristine-typescript-react-material-ui-monaco-playground/issues) for a list of proposed features (and known issues).
 
-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:
+<!-- template just leave alone  -->
+## Contributing
+How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.
 
-Using conventions, documentation and specifications make it easier to:
-- communicate the problem you are solving
-- ease onboarding
-- build and use composable tools
-- promote open source contribution and engagement
-- promote issue and feature discussion on Github itself
+## License
+Apache License 2.0
 
-#### Resources
+<!-- references and additional resources  -->
+## Resources
 
 - [Pristine](https://github.com/etclabscore/pristine)
 - [material-ui](https://material-ui.com)
@@ -47,14 +75,4 @@ Using conventions, documentation and specifications make it easier to:
 - [Literate programming](https://en.wikipedia.org/wiki/Literate_programming)
 - [Hammock Driven Development](https://www.youtube.com/watch?v=f84n5oFoZBc)
 - [Inversion and The Power of Avoiding Stupidity](https://fs.blog/2013/10/inversion/)
-- [choosealicense.com](http://choosealicense.com)
-
-## Getting Started
-
-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.
-
-Then edit the `package.json` and change the `name` and `homepage` fields to match your newly created repository.
-
-### Contributing
-
-How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.
+- [choosealicense.com](http://choosealicense.com)