Skip to content

Commit

Permalink
Made "Feature Toggle" plural in the first sentence so it fits better …
Browse files Browse the repository at this point in the history
…with the rest of the sentence. In the description of feature toggle uses, changed "we" to "you" in item tacitknowledge#3 to match the descriptions in the other two list items. Under "Licensing", change the phrase"The text of the license you can find at" to "You can find the license text at" so it reads smoother. Under "Contributing" changed item tacitknowledge#4 from "Push to the branch" to "Push to the remote branch" to make the goal clearer, and item tacitknowledge#5 from "Create new Pull Request" to "Create a new Pull Request" so it reads better.
  • Loading branch information
Burk Hufnagel authored and Burk Hufnagel committed Oct 4, 2020
1 parent 0e2c57a commit a1e5dfc
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Flip - A feature toggling framework

Flip makes it simple to use [Feature Toggle](http://martinfowler.com/bliki/FeatureToggle.html),
Flip makes it simple to use [Feature Toggles](http://martinfowler.com/bliki/FeatureToggle.html),
(also known as Feature Flags, Feature Bits, Feature Switches, etc) in your Java application.

Feature toggles can be used for many purposes, including:

1. Reducing the need to branch by feature in your source control system by having all work done on the main code line.
Features that are not ready for production can simply be disabled.
2. New features can be rolled out to a subset of users (e.g. by group membership, canary testing, etc)
2. Should a feature become problematic, we can turn it off without requiring a build and deploy.
2. Should a feature become problematic, you can turn it off without requiring a build and deploy.

# Start Using Flip

Expand All @@ -21,21 +21,20 @@ Flip is available in Maven Central under the following identifiers:
If you're using Ant we recommend that you use Apache Ivy. If you can't do that for whatever reason, take a look at our
[instructions for installation under Ant](https://github.com/tacitknowledge/flip/wiki/Installation-under-Ant).

The quickest way to understand how to use Flip is by looking in at the [examples](https://github.com/tacitknowledge/flip/tree/master/examples).
The quickest way to understand how to use Flip is by looking at the [examples](https://github.com/tacitknowledge/flip/tree/master/examples).

# Documentation

The documentation for Flip is on the [Flip Wiki](https://github.com/tacitknowledge/flip/wiki)

# Licensing

This framework is released under Apache 2.0 Public License. The text of the
license you can find at http://www.apache.org/licenses/LICENSE-2.0.txt.
This framework is released under Apache 2.0 Public License. You can find the license text at http://www.apache.org/licenses/LICENSE-2.0.txt.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
4. Push to the remote branch (`git push origin my-new-feature`)
5. Create a new Pull Request

0 comments on commit a1e5dfc

Please sign in to comment.