Skip to content

Commit a5bd8b4

Browse files
authored
Merge pull request #2 from kinoplan/update_readme
Update readme
2 parents a9b5ee2 + fe1b411 commit a5bd8b4

File tree

1 file changed

+35
-34
lines changed

1 file changed

+35
-34
lines changed

README.md

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,39 @@
1-
# scalajs-react-material-ui
1+
<h1 align="center">scalajs-react-material-ui</h1>
22

3-
![Scala CI](https://github.com/kinoplan/scalajs-react-material-ui/workflows/Scala%20CI/badge.svg?branch=master)
3+
<div align="center">
4+
5+
[scalajs-react](https://github.com/japgolly/scalajs-react) facade developed with [scalajs-react-bridge](https://github.com/payalabs/scalajs-react-bridge) for [@material-ui/core](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui), [@material-ui/icons](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui-icons), [@material-ui/lab](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui-lab)
46

7+
![Scala CI](https://github.com/kinoplan/scalajs-react-material-ui/workflows/Scala%20CI/badge.svg?branch=master)
8+
[![Maven Central](https://img.shields.io/maven-central/v/io.kinoplan/scalajs-react-material-ui-core_sjs0.6_2.12.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.kinoplan%22%20AND%20(a:%22scalajs-react-material-ui-core_sjs0.6_2.12%22%20OR%20a:%22scalajs-react-material-ui-icons_sjs0.6_2.12%22%20OR%20a:%22scalajs-react-material-ui-lab_sjs0.6_2.12%22))
59
[![Scala](https://img.shields.io/badge/Scala-2.12.10-red.svg?logo=Scala&logoColor=red)](https://www.scala-lang.org/)
610
[![Scala.js](https://img.shields.io/badge/Scala.js-0.6.32-orange.svg?logo=Scala&logoColor=orange)](https://www.scala-js.org/)
711
[![react](https://img.shields.io/badge/react-16.7.0-61DAFB.svg?logo=React)](https://ru.reactjs.org/)
812
[![scalajs-react](https://img.shields.io/static/v1?label=scalajs-react&message=1.6.0&color=blue)](https://github.com/japgolly/scalajs-react)
13+
[![material-ui](https://img.shields.io/static/v1?label=material-ui&message=3.9.0&color=ff69b4)](https://v3.material-ui.com/)
914

10-
[![material-ui-core](https://img.shields.io/static/v1?label=@material-ui/core&message=3.9.0&color=ff69b4)](https://v3.material-ui.com/)
11-
[![material-ui-icons](https://img.shields.io/static/v1?label=@material-ui/icons&message=3.0.2&color=ff69b4)](https://v3.material-ui.com/)
12-
[![material-ui-lab](https://img.shields.io/static/v1?label=@material-ui/lab&message=3.0.0-alpha.30&color=ff69b4)](https://v3.material-ui.com/)
13-
14-
[![Maven Central](https://img.shields.io/maven-central/v/io.kinoplan/scalajs-react-material-ui-core_sjs0.6_2.12.svg?label=scalajs-react-material-ui-core)](https://search.maven.org/search?q=g:%22io.kinoplan%22%20AND%20a:%22scalajs-react-material-ui-core_sjs0.6_2.12%22)
15-
[![Maven Central](https://img.shields.io/maven-central/v/io.kinoplan/scalajs-react-material-ui-icons_sjs0.6_2.12.svg?label=scalajs-react-material-ui-icons)](https://search.maven.org/search?q=g:%22io.kinoplan%22%20AND%20a:%22scalajs-react-material-ui-icons_sjs0.6_2.12%22)
16-
[![Maven Central](https://img.shields.io/maven-central/v/io.kinoplan/scalajs-react-material-ui-lab_sjs0.6_2.12.svg?label=scalajs-react-material-ui-lab)](https://search.maven.org/search?q=g:%22io.kinoplan%22%20AND%20a:%22scalajs-react-material-ui-lab_sjs0.6_2.12%22)
17-
18-
[scalajs-react](https://github.com/japgolly/scalajs-react) facade developed with [scalajs-react-bridge](https://github.com/payalabs/scalajs-react-bridge) for:
19-
* [@material-ui/core](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui)
20-
* [@material-ui/icons](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui-icons)
21-
* [@material-ui/lab](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui-lab)
15+
</div>
2216

2317
## Usage
24-
Add `libraryDependencies` to your [scalajs-react](https://github.com/japgolly/scalajs-react) project:
25-
```scala
26-
libraryDependencies ++= Seq(
27-
"io.kinoplan" %%% "scalajs-react-material-ui-core" % "0.0.1",
28-
"io.kinoplan" %%% "scalajs-react-material-ui-icons" % "0.0.1",
29-
"io.kinoplan" %%% "scalajs-react-material-ui-lab" % "0.0.1"
30-
)
31-
```
32-
33-
Add `npmDependencies` using [scalajs-bundler](https://scalacenter.github.io/scalajs-bundler/):
34-
```scala
35-
npmDependencies in Compile ++= Seq(
36-
"@material-ui/core" -> "3.9.0",
37-
"@material-ui/icons" -> "3.0.2",
38-
"@material-ui/lab" -> "3.0.0-alpha.30"
39-
)
40-
```
18+
1. Add `libraryDependencies` to your [scalajs-react](https://github.com/japgolly/scalajs-react) project:
19+
20+
```scala
21+
libraryDependencies ++= Seq(
22+
"io.kinoplan" %%% "scalajs-react-material-ui-core" % "0.0.1",
23+
"io.kinoplan" %%% "scalajs-react-material-ui-icons" % "0.0.1",
24+
"io.kinoplan" %%% "scalajs-react-material-ui-lab" % "0.0.1"
25+
)
26+
```
27+
28+
2. Add `npmDependencies` using [scalajs-bundler](https://scalacenter.github.io/scalajs-bundler/):
29+
30+
```scala
31+
npmDependencies in Compile ++= Seq(
32+
"@material-ui/core" -> "3.9.0",
33+
"@material-ui/icons" -> "3.0.2",
34+
"@material-ui/lab" -> "3.0.0-alpha.30"
35+
)
36+
```
4137

4238
## Demo
4339

@@ -46,9 +42,14 @@ See the [demo](/demo) project.
4642
The project has almost all the examples in the js
4743
[Component Demos](https://v3.material-ui.com/getting-started/installation/) written in Scala!
4844

49-
In the demo you can also find very detailed examples of using a bunch of [scala.js](http://scala-js.org),
50-
[scalajs-react](https://github.com/japgolly/scalajs-react), [scalacss](https://github.com/japgolly/scalacss)
51-
and [scalajs-react-material-ui](https://github.com/kinoplan/scalajs-react-material-ui) facade in Scala frontend!
45+
In the demo you can also find very detailed examples of using a bunch of:
46+
47+
- [scala.js](http://scala-js.org)
48+
- [scalajs-dom](http://scala-js.github.io/scala-js-dom/)
49+
- [scalajs-react](https://github.com/japgolly/scalajs-react)
50+
- [scalacss](https://github.com/japgolly/scalacss)
51+
- [scalajs-react-material-ui](https://github.com/kinoplan/scalajs-react-material-ui)
52+
- [ScalablyTyped/Distribution](https://github.com/ScalablyTyped/Distribution)
5253

5354
Start:
5455
1. `sbt`

0 commit comments

Comments
 (0)