From c0d8e632d9544e6588c62fc11f3b321830b7e6ed Mon Sep 17 00:00:00 2001 From: Unknown Date: Mon, 15 Jan 2018 03:35:41 +0100 Subject: [PATCH] 0.1 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c3bf5b4..6b69615 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ Scammander is a command library for Scala that focues on typesafe and simple com Big thanks to the Sponge library for some of the ideas and designs that are used in Scammander. If you know how to use one, using the other will hopefully not be too hard. ## Basic Usage +While Scammander is still early in development, you can try Scammander by adding one of these to your `build.sbt`. +```scala +//Core library. Use this if you want to create an implmentation for a new platform +libraryDependencies += "net.katsstuff" %% "scammander" % "0.1.0" +libraryDependencies += "net.katsstuff" %% "scammander-sponge7" % "0.1.0" //Sponge API 7 platform +libraryDependencies += "net.katsstuff" %% "scammander-bukkit" % "0.1.0" //Bukkit platform +``` + So, how do you use Scammander. Let's go over how to use it with Sponge. Usage for the other platforms should be somewhat similar. All examples here assumes. ```scala import net.katsstuff.scammander.sponge._