diff --git a/build.sbt b/build.sbt index 26c522b5b3..8bef0fc568 100644 --- a/build.sbt +++ b/build.sbt @@ -358,6 +358,9 @@ lazy val nodeTest = lazy val testkit = project .in(file("testkit")) .settings(CommonSettings.prodSettings: _*) + .settings( + name := "bitcoin-s-testkit" + ) .dependsOn( core % testAndCompile, appServer, diff --git a/docs/getting-started.md b/docs/getting-started.md index 60a258be94..a89864090e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,8 +1,20 @@ --- id: getting-started -title: Add Bitcoin-S to your project +title: Intro and Getting Started --- +## Philosophy + +Bitcoin-S is a loosely coupled set of cryptocurrency libraries for the JVM. They work well together, but also can be used +independently. This project's goal is NOT to be a full node implementation, rather a set of scalable cryptocurrency libraries +that use industry standard tools (rather than esoteric tech often found in cryptocurrency) where possible to make the lives of professional +software engineers, security engineers, devops engineers and accountants easier. +We are rapidly iterating on development with the goal of getting to a set of stable APIs that only change when the underlying bitcoin protocol changes. + +If you are a professional working a cryptocurrency business and +have feedback on how to make your lives easier, please reach out on [slack](https://join.slack.com/t/suredbits/shared_invite/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM), +[gitter](https://gitter.im/bitcoin-s-core/) or [twitter](https://twitter.com/Chris_Stewart_5/)! + ## If you want to setup Bitcoin-S locally Then go to [this document](getting-setup.md). @@ -11,7 +23,7 @@ Then go to [this document](getting-setup.md). You can try out Bitcoin-S in a REPL in a matter of seconds. Run the provided ["try bitcoin-s"](https://github.com/bitcoin-s/bitcoin-s-core/blob/master/try-bitcoin-s.sh) -script, which has no dependencies other than an installed JDK. The script +script, which has no dependencies other than an installed *Java 8*. The script downloads and installs [Coursier](https://get-coursier.io/) and uses it to fetch the [Ammonite](https://ammonite.io) REPL and the latest version of Bitcoin-S. It then drops you into immediately into a REPL session. @@ -44,10 +56,18 @@ libraryDependencies +="org.bitcoin-s" % "bitcoin-s-secp256k1jni" % "@STABLE_VERS libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-core" % "@STABLE_VERSION@" +libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-chain" % "@STABLE_VERSION@" + libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-bitcoind-rpc" % "@STABLE_VERSION@" libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-eclair-rpc" % "@STABLE_VERSION@" +libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-key-manager" % "@STABLE_VERSION@" + +libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-node" % "@STABLE_VERSION@" + +libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-wallet" % "@STABLE_VERSION@" + libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit" % "@STABLE_VERSION@" libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "@STABLE_VERSION@" @@ -75,6 +95,14 @@ ${List.fill(3)("`").mkString /* Hacky solution to get around nesting backticks * ``` +The official maven repo for releases is + +https://repo1.maven.org/maven2/org/bitcoin-s/ + +The repo for snapshots, which are published after everytime something is merged to master: + +https://oss.sonatype.org/content/repositories/snapshots/org/bitcoin-s/ + ### Mill TODO