Skip to content

Commit a9b5ee2

Browse files
authored
Update README.md
1 parent c354f8f commit a9b5ee2

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# scalajs-react-material-ui
1+
# scalajs-react-material-ui
22

33
![Scala CI](https://github.com/kinoplan/scalajs-react-material-ui/workflows/Scala%20CI/badge.svg?branch=master)
44

@@ -11,10 +11,33 @@
1111
[![material-ui-icons](https://img.shields.io/static/v1?label=@material-ui/icons&message=3.0.2&color=ff69b4)](https://v3.material-ui.com/)
1212
[![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/)
1313

14-
[scalajs-react](https://github.com/japgolly/scalajs-react) facade for :
15-
* [@material-ui/core v3.9.0](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui)
16-
* [@material-ui/icons v3.0.2](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui-icons)
17-
* [@material-ui/lab v3.0.0-alpha.30](https://github.com/mui-org/material-ui/tree/v3.x/packages/material-ui-lab)
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)
22+
23+
## 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+
```
1841

1942
## Demo
2043

0 commit comments

Comments
 (0)