Skip to content

Commit bc0b899

Browse files
committed
Update README for Spark 3
1 parent 33bb8d3 commit bc0b899

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,24 @@
22

33
String similarity functions and phonetic algorithms for Spark.
44

5-
See [ceja](https://github.com/MrPowers/ceja) if you're using the PySpark API.
5+
See [ceja](https://github.com/MrPowers/ceja) if you're using PySpark.
66

77
## Project Setup
88

99
Update your `build.sbt` file to import the libraries.
1010

1111
```
1212
libraryDependencies += "org.apache.commons" % "commons-text" % "1.1"
13+
14+
// Spark 3
15+
libraryDependencies += "com.github.mrpowers" %% "spark-stringmetric" % "0.4.0"
16+
17+
// Spark 2
1318
libraryDependencies += "com.github.mrpowers" %% "spark-stringmetric" % "0.3.0"
1419
```
1520

1621
You can find the spark-daria [Scala 2.11 versions here](https://repo1.maven.org/maven2/com/github/mrpowers/spark-stringmetric.11/) and the [Scala 2.12 versions here](https://repo1.maven.org/maven2/com/github/mrpowers/spark-stringmetric.12/).
1722

18-
You should generally use Scala 2.11 with Spark 2 and Scala 2.12 with Spark 3.
19-
2023
## SimilarityFunctions
2124

2225
* `cosine_distance`
@@ -131,7 +134,7 @@ Run `sbt` to open the SBT console.
131134

132135
Run `> ; + publishSigned; sonatypeBundleRelease` to create the JAR files and release them to Maven. These commands are made available by the [sbt-sonatype](https://github.com/xerial/sbt-sonatype) plugin.
133136

134-
When the release command is run, you'll be prompted to enter your GPG passphrase.
137+
After running the release command, you'll be prompted to enter your GPG passphrase.
135138

136139
The Sonatype credentials should be stored in the `~/.sbt/sonatype_credentials` file in this format:
137140

@@ -142,8 +145,7 @@ user=$USERNAME
142145
password=$PASSWORD
143146
```
144147

145-
## Microsite
146-
147-
The microsite for this project [is available here](https://mrpowers.github.io/spark-stringmetric/). It's built with the [sbt-microsite](https://github.com/47degrees/sbt-microsites) plugin.
148+
## Post Maven release steps
148149

149-
The `sbt publishMicrosite` command creates a new microsite based on the Markdown files stored in the `docs/src/main/mdoc` folder.
150+
* Create a GitHub release/tag
151+
* Publish the updated documentation

0 commit comments

Comments
 (0)