Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lukespragg committed Sep 15, 2015
1 parent 253683f commit e8a5092
Showing 1 changed file with 22 additions and 32 deletions.
54 changes: 22 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Flow Plugins [![License](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)][License] [![Flattr this](http://img.shields.io/badge/flattr-donate-lightgrey.svg?style=flat)][Donate] [![Build Status](http://img.shields.io/travis/flow/flow-plugins/master.svg?style=flat)](https://travis-ci.org/flow/flow-plugins) [![Coverage Status](http://img.shields.io/coveralls/flow/flow-plugins/master.svg?style=flat)](https://coveralls.io/r/flow/flow-plugins)

Flow Plugins is an extensible and modular library for creating Java-based plugins that are loaded separate from the main codebase at runtime.
Extensible and modular library for creating Java-based plugins that are loaded separate from the main codebase at runtime.

## Getting Started
* [Examples and code snippets](https://github.com/flow/examples/tree/master/plugins)
* [Official documentation](#documentation)
* [IRC support chat](http://kiwiirc.com/client/irc.esper.net/flow)
* [Issues tracker](https://github.com/flow/flow-plugins/issues)
* [Issues tracker](https://github.com/flow/plugins/issues)

## Source Code
The latest and greatest source can be found here on [GitHub](https://github.com/flow/flow-plugins). If you are using Git, use this command to clone the project:
The latest and greatest source can be found here on [GitHub](https://github.com/flow/plugins). If you are using Git, use this command to clone the project:

git clone git://github.com/flow/flow-plugins.git
git clone git://github.com/flow/plugins.git

Or download the [latest zip archive](https://github.com/flow/flow-plugins/archive/master.zip).
Or download the latest [development archive](https://github.com/flow/caustic/archive/develop.zip) or the latest [stable archive](https://github.com/flow/caustic/archive/master.zip).

## Dependencies
We love open-source libraries! This project uses are few of them to make things easier. If you aren't using Maven or Gradle, you'll need these!
* [com.flowpowered:flow-commons](https://oss.sonatype.org/#nexus-search;gav~com.flowpowered~flow-commons~~~)
* [com.flowpowered:flow-cerealization](https://oss.sonatype.org/#nexus-search;gav~com.flowpowered~flow-cerealization~~~)
* [com.flowpowered:flow-persistence](https://oss.sonatype.org/#nexus-search;gav~com.flowpowered~flow-persistence~~~)
* [com.flowpowered:reflections](https://oss.sonatype.org/#nexus-search;gav~com.flowpowered~reflections~~~)

## Building from Source
This project can be built with the _latest_ [Java Development Kit](http://oracle.com/technetwork/java/javase/downloads) and [Maven](http://maven.apache.org/) or [Gradle](http://www.gradle.org/). Maven and Gradle are used to simplify dependency management, but using either of them is optional.
This project can be built with the _latest_ [Java Development Kit](http://oracle.com/technetwork/java/javase/downloads) and [Maven](https://maven.apache.org/) or [Gradle](https://www.gradle.org/). Maven and Gradle are used to simplify dependency management, but using either of them is optional.

For Maven, the command `mvn clean package` will build the project and will put the compiled JAR in `target`, and `mvn clean install` will copy it to your local Maven repository.

Expand All @@ -37,60 +37,50 @@ Are you a talented programmer looking to contribute some code? We'd love the hel

Love the project? Feel free to [donate] to help continue development! Flow projects are open-source and powered by community members, like yourself. Without you, we wouldn't be here today!

Please don't forget to follow and star our repo! Join our growing community to keep up to date with the latest Flow development.
Don't forget to watch and star our repo to keep up-to-date with the latest Flow development!

## Usage
If you're using [Maven](http://maven.apache.org/download.html) to manage project dependencies, simply include the following in your `pom.xml` file:
If you're using [Maven](https://maven.apache.org/download.html) to manage project dependencies, simply include the following in your `pom.xml` file:

<dependency>
<groupId>com.flowpowered</groupId>
<artifactId>flow-plugins</artifactId>
<version>0.1.0-SNAPSHOT</version>
</dependency>

If you do not already have the required repo in your repository list, you will need to add this as well:

<repository>
<id>sonatype-nexus</id>
<url>https://oss.sonatype.org/content/groups/public</url>
</repository>

If you're using [Gradle](http://www.gradle.org/) to manage project dependencies, simply include the following in your `build.gradle` file:
If you're using [Gradle](https://www.gradle.org/) to manage project dependencies, simply include the following in your `build.gradle` file:

repositories {
mavenLocal()
mavenCentral()
maven {
name = 'sonatype-nexus'
url = 'https://oss.sonatype.org/content/groups/public/'
}
}
dependencies {
compile 'com.flowpowered:flow-plugins:0.1.0-SNAPSHOT'
}

If you'd prefer to manually import the latest .jar file, you can get it [here](https://github.com/flow/flow-plugins/releases).
If you plan on using snapshots and do not already have the snapshot repo in your repository list, you will need to add this as well:

https://oss.sonatype.org/content/groups/public/

If you'd prefer to manually import the latest .jar file, you can get it [here](https://github.com/flow/plugins/releases).

## Documentation
Want to get friendly with the project and put it to good use? Check out the latest [Javadocs](http://plugins.flowpowered.com/).
Want to get friendly with the project and put it to good use? Check out the latest [Javadocs](https://flowpowered.com/plugins).

To generate the the Javadocs with Maven, use the `mvn javadoc:javadoc` command. To view the javadocs simply go to `target/site/apidocs/` and open `index.html` in a web browser.
To generate Javadocs with Maven, use the `mvn javadoc:javadoc` command. To view the Javadocs simply go to `target/site/apidocs/` and open `index.html` in a web browser.

To generate Javadocs with Gradle, use the `gradlew javadoc` command. To view the javadocs simply go to `build/docs/javadoc/` and open `index.html` in a web browser.
To generate Javadocs with Gradle, use the `gradlew javadoc` command. To view the Javadocs simply go to `build/docs/javadoc/` and open `index.html` in a web browser.

## Version Control
We've adopted the [git flow branching model](http://nvie.com/posts/a-successful-git-branching-model/) in our projects. The creators of git flow released a [short intro video](http://vimeo.com/16018419) to explain the model.

The `master` branch is production-ready, but is not yet vetted for release. Only small patches and `hotfix/x` branches are pushed to `master`, and will always have a release version. The `develop` and `stage` branches are pre-production, and are where we push `feature/x` branches for testing.

Our release branches are named by version number, e.g. `1.0` and `1.1`. We begin release branches with a beta (b1) designation and progress them through release candidate to stable. All open source releases (included pre-releases) are tagged.
The `master` branch is production-ready and contains the latest tagged releases. Before a release is made, it is stagged in `release/x` branches before being pushed and tagged in the `master` branch. Small patches from `hotfix/x` branches are also pushed to `master`, and will always have a release version. The `develop` branch is pre-production, and is where we push `feature/x` branches for testing.

## Legal Stuff
Flow Plugins is licensed under the [MIT License][License]. Basically, you can do whatever you want as long as you include the original copyright. Please see the `LICENSE.txt` file for details.

## Credits
* [Spout](https://spout.org/) and contributors - *where we all began, and for much of the re-licensed code.*
* All the people behind [Java](http://www.oracle.com/technetwork/java/index.html), [Maven](http://maven.apache.org/), and [Gradle](http://www.gradle.org/).
* All the people behind [Java](http://www.oracle.com/technetwork/java/index.html), [Maven](https://maven.apache.org/), and [Gradle](https://www.gradle.org/).

[Donate]: https://flattr.com/submit/auto?user_id=spout&url=https://github.com/flow/flow-plugins&title=Flow+Plugins&language=Java&tags=github&category=software
[License]: https://tldrlegal.com/license/mit-license
[Donate]: https://flattr.com/submit/auto?user_id=spout&url=https://github.com/flow/plugins&title=Flow+Plugins&language=Java&tags=github&category=software
[License]: https://tldrlegal.com/l/mit

0 comments on commit e8a5092

Please sign in to comment.