Skip to content
This repository was archived by the owner on Jun 1, 2020. It is now read-only.

Commit 41e33e6

Browse files
committed
Add rjsf-material-ui logo and update README
1 parent c9b31ca commit 41e33e6

File tree

2 files changed

+30
-41
lines changed

2 files changed

+30
-41
lines changed

README.md

Lines changed: 30 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55
*** Thanks again! Now go create something AMAZING! :D
66
-->
77

8-
9-
10-
11-
128
<!-- PROJECT SHIELDS -->
139
<!--
1410
*** I'm using markdown "reference style" links for readability.
@@ -17,17 +13,16 @@
1713
*** for build-url, contributors-url, etc. This is an optional, concise syntax you may use.
1814
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
1915
-->
16+
2017
[![Build Status][build-shield]][build-url]
2118
[![Contributors][contributors-shield]][contributors-url]
2219
[![MIT License][license-shield]][license-url]
2320

24-
25-
2621
<!-- PROJECT LOGO -->
2722
<br />
2823
<p align="center">
2924
<a href="https://github.com/cybertec-postgresql/rjsf-material-ui">
30-
<img src="material-ui-logo.svg" alt="Logo" width="80" height="80">
25+
<img src="rjsf-material-ui-logo.png" alt="Logo" width="120" height="120">
3126
</a>
3227

3328
<h3 align="center">rjsf-material-ui</h3>
@@ -46,25 +41,23 @@
4641
</p>
4742
</p>
4843

49-
50-
5144
<!-- TABLE OF CONTENTS -->
52-
## Table of Contents
53-
54-
* [About the Project](#about-the-project)
55-
* [Built With](#built-with)
56-
* [Getting Started](#getting-started)
57-
* [Prerequisites](#prerequisites)
58-
* [Installation](#installation)
59-
* [Usage](#usage)
60-
* [Roadmap](#roadmap)
61-
* [Contributing](#contributing)
62-
* [License](#license)
63-
* [Contact](#contact)
6445

46+
## Table of Contents
6547

48+
- [About the Project](#about-the-project)
49+
- [Built With](#built-with)
50+
- [Getting Started](#getting-started)
51+
- [Prerequisites](#prerequisites)
52+
- [Installation](#installation)
53+
- [Usage](#usage)
54+
- [Roadmap](#roadmap)
55+
- [Contributing](#contributing)
56+
- [License](#license)
57+
- [Contact](#contact)
6658

6759
<!-- ABOUT THE PROJECT -->
60+
6861
## About The Project
6962

7063
[![rjsf-material-ui Screen Shot][product-screenshot]](https://cybertec-postgresql.github.io/rjsf-material-ui)
@@ -73,20 +66,20 @@ Exports `material-ui` theme, fields and widgets for `react-jsonschema-form`.
7366

7467
### Built With
7568

76-
* [react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form/)
77-
* [Material-UI](https://material-ui.com/)
78-
* [Typescript](https://www.typescriptlang.org/)
79-
80-
69+
- [react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form/)
70+
- [Material-UI](https://material-ui.com/)
71+
- [Typescript](https://www.typescriptlang.org/)
8172

8273
<!-- GETTING STARTED -->
74+
8375
## Getting Started
8476

8577
### Prerequisites
8678

8779
- `@material-ui/core >= 4.2.0` ([in 4.2.0, the `slider` component was added to the core](https://github.com/mui-org/material-ui/pull/16416))
8880
- `@material-ui/icons`
8981
- `react-jsonschema-form >= 1.6.0` ([in 1.6.0, the `withTheme` HOC was added](https://github.com/mozilla-services/react-jsonschema-form/pull/1226))
82+
9083
```sh
9184
yarn add @material-ui/core @material-ui/icons react-jsonschema-form
9285
```
@@ -97,31 +90,31 @@ yarn add @material-ui/core @material-ui/icons react-jsonschema-form
9790
yarn add rjsf-material-ui
9891
```
9992

100-
101-
10293
<!-- USAGE EXAMPLES -->
94+
10395
## Usage
10496

10597
```javascript
106-
import { withTheme } from "react-jsonschema-form";
107-
import { Theme as MuiTheme } from "rjsf-material-ui";
98+
import { withTheme } from 'react-jsonschema-form';
99+
import { Theme as MuiTheme } from 'rjsf-material-ui';
108100

109101
const Form = withTheme(MuiTheme);
110102
```
103+
111104
or
105+
112106
```javascript
113-
import MuiForm from "rjsf-material-ui";
107+
import MuiForm from 'rjsf-material-ui';
114108
```
115109

116-
117110
<!-- ROADMAP -->
111+
118112
## Roadmap
119113

120114
See the [open issues](https://cybertec-postgresql.github.io/rjsf-material-ui/issues) for a list of proposed features (and known issues).
121115

122-
123-
124116
<!-- CONTRIBUTING -->
117+
125118
## Contributing
126119

127120
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
@@ -132,27 +125,23 @@ Contributions are what make the open source community such an amazing place to b
132125
4. Push to the Branch (`git push origin feature/AmazingFeature`)
133126
5. Open a Pull Request
134127

135-
136-
137128
<!-- LICENSE -->
129+
138130
## License
139131

140132
Distributed under the MIT License. See `LICENSE` for more information.
141133

142-
143-
144134
<!-- CONTACT -->
135+
145136
## Contact
146137

147138
Cybertec TEAM - [@postgressupport](https://twitter.com/postgressupport) - office@cybertec.at
148139

149140
Project Link: [https://cybertec-postgresql.github.io/rjsf-material-ui](https://cybertec-postgresql.github.io/rjsf-material-ui)
150141

151-
152-
153-
154142
<!-- MARKDOWN LINKS & IMAGES -->
155143
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
144+
156145
[build-shield]: https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square
157146
[build-url]: #
158147
[contributors-shield]: https://img.shields.io/badge/contributors-1-orange.svg?style=flat-square

rjsf-material-ui-logo.png

80.2 KB
Loading

0 commit comments

Comments
 (0)