Skip to content

Commit

Permalink
Adds a basic installation section in the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
juanpedromoreno committed Sep 23, 2016
1 parent fdd4fdb commit e31c37f
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,21 @@ A microsite is an instance of Jekyll, ready to publish a static web page for you
- Templates, layouts, styles, and other resources will be able through the plugin at compile time.
- You don't have to deal with the styling.

Please see the [documentation](https://47deg.github.io/sbt-microsites/docs/) for more information on setup, installation, etc.
# Installation

To Begin, add the following lines to the `project/plugins.sbt` file within your project or sbt module where you want to use the `sbt-microsites` plugin.

```
addSbtPlugin("com.fortysevendeg" % "sbt-microsites" % "0.2.0")
```

Finally, to enable the plugin, add this to your `build.sbt` file:
```
enablePlugins(MicrositesPlugin)
```

Anyway, take a look at the `Getting Started` section at the [documentation](https://47deg.github.io/sbt-microsites/docs/getting-started.html) since there are some prerequisites that are needed to build your microsite.

# Documentation

Please see the [documentation](https://47deg.github.io/sbt-microsites/docs/) for more details about setup, installation, customization, etc.

0 comments on commit e31c37f

Please sign in to comment.