Skip to content

Commit

Permalink
Update READMEs with info about Maven Central
Browse files Browse the repository at this point in the history
  • Loading branch information
Leonya committed May 21, 2021
1 parent 0964ef0 commit b0ea690
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 131 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,9 @@ To learn more please refer to the READMEs of individual modules:
* [kotlin-redux](kotlin-redux/README.md),
* [kotlin-styled](kotlin-styled/README.md).

All wrappers are available on npm: `npm install @jetbrains/<wrapper name>`
Artifacts are published to Maven Central, see the corresponding README files for package coordinates.

Maven and Gradle artifacts are published to [kotlin.jetbrains.space](https://kotlin.jetbrains.space), see the corresponding README files for package coordinates.

```kotlin
// build.gradle.kts
repositories {
mavenCentral()
maven("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
```
**Important:** versions up to pre.156 were published under `org.jetbrains` group ID to kotlin.jetbrains.space, newer versions are being published to Maven Central and the new group ID is `org.jetbrains.kotlin-wrappers`. Upon changing the group ID the version number was bumped to pre.200 to signal the breaking change.

**All packages require JDK 8 to be installed.**

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
group=org.jetbrains.kotlin-wrappers
version=1.0-SNAPSHOT
version.build=pre.201
version.build=pre.203

kotlin.code.style=official
kotlin.js.compiler=both
Expand Down
15 changes: 3 additions & 12 deletions kotlin-css/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ Platform-agnostic CSS primitives.

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-css</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -25,12 +18,10 @@ Platform-agnostic CSS primitives.

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-css:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-css:VERSION")
```

### Getting Started
Expand Down
15 changes: 3 additions & 12 deletions kotlin-extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,8 @@ Kotlin wrappers for standard JS objects as well as some helpers required for

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-extensions</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -26,10 +19,8 @@ Kotlin wrappers for standard JS objects as well as some helpers required for

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-extensions:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-extensions:VERSION")
```
15 changes: 3 additions & 12 deletions kotlin-mocha/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ Kotlin wrapper for Mocha test framework. Major version number of this wrapper ma

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-mocha</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -25,10 +18,8 @@ Kotlin wrapper for Mocha test framework. Major version number of this wrapper ma

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-mocha:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-mocha:VERSION")
```
15 changes: 3 additions & 12 deletions kotlin-react-dom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ Kotlin wrapper for React DOM library. Major version number of this wrapper match

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-react-dom</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -25,12 +18,10 @@ Kotlin wrapper for React DOM library. Major version number of this wrapper match

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-react-dom:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-react-dom:VERSION")
```

### Internals
Expand Down
15 changes: 3 additions & 12 deletions kotlin-react-redux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ Kotlin wrapper for React Redux library. Major version number of this wrapper mat

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-react-redux</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -25,12 +18,10 @@ Kotlin wrapper for React Redux library. Major version number of this wrapper mat

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-react-redux:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-react-redux:VERSION")
```

### Usage
Expand Down
15 changes: 3 additions & 12 deletions kotlin-react-router-dom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,8 @@ Both BrowserRouter and HashRouter are supported.

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-react-router-dom</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -28,12 +21,10 @@ Both BrowserRouter and HashRouter are supported.

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-react-router-dom:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-react-router-dom:VERSION")
```

### Examples
Expand Down
15 changes: 3 additions & 12 deletions kotlin-react-table/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ Kotlin wrappers for [React Table](https://github.com/tannerlinsley/react-table)

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-react-table</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -25,12 +18,10 @@ Kotlin wrappers for [React Table](https://github.com/tannerlinsley/react-table)

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-react-table:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-react-table:VERSION")
```

### Supported hooks
Expand Down
15 changes: 3 additions & 12 deletions kotlin-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ Kotlin wrapper for React library. Major version number of this wrapper matches t

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-react</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -25,12 +18,10 @@ Kotlin wrapper for React library. Major version number of this wrapper matches t

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-react:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-react:VERSION")
```

### Getting started
Expand Down
15 changes: 3 additions & 12 deletions kotlin-redux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ Kotlin wrapper for Redux library. Major version number of this wrapper matches t

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-redux</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -25,12 +18,10 @@ Kotlin wrapper for Redux library. Major version number of this wrapper matches t

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-redux:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-redux:VERSION")
```

### Creating and using a store in Kotlin
Expand Down
15 changes: 3 additions & 12 deletions kotlin-styled/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,8 @@ Major version number of this wrapper matches that of styled-components itself.

```xml
<project>
<repositories>
<repository>
<id>space-kotlin-js-wrappers</id>
<url>https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers</url>
</repository>
</repositories>

<dependency>
<groupId>org.jetbrains</groupId>
<groupId>org.jetbrains.kotlin-wrappers</groupId>
<artifactId>kotlin-styled</artifactId>
<version>VERSION</version>
</dependency>
Expand All @@ -27,12 +20,10 @@ Major version number of this wrapper matches that of styled-components itself.

```kotlin
repositories {
maven {
url = uri("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/kotlin-js-wrappers")
}
mavenCentral()
}

implementation("org.jetbrains:kotlin-styled:VERSION")
implementation("org.jetbrains.kotlin-wrappers:kotlin-styled:VERSION")
```

### Getting Started
Expand Down

0 comments on commit b0ea690

Please sign in to comment.