README.md in solve-0.8.2 vs README.md in solve-1.0.0.rc1

- old
+ new

@@ -1,9 +1,12 @@ # Solve -[![Gem Version](https://badge.fury.io/rb/solve.png)](http://badge.fury.io/rb/solve) -[![Build Status](https://secure.travis-ci.org/berkshelf/solve.png?branch=master)](http://travis-ci.org/berkshelf/solve) +[![Gem Version](http://img.shields.io/gem/v/solve.svg)][gem] +[![Build Status](http://img.shields.io/travis/berkshelf/solve.svg)][travis] +[gem]: https://rubygems.org/gems/solve +[travis]: http://travis-ci.org/berkshelf/solve + A Ruby versioning constraint solver implementing [Semantic Versioning 2.0.0](http://semver.org). ## Installation $ gem install solve @@ -14,33 +17,27 @@ graph = Graph.new Add an artifact to the graph - graph.artifacts("nginx", "1.0.0") + graph.artifact("nginx", "1.0.0") Now add another artifact that has a dependency - graph.artifacts("mysql", "1.2.4-alpha.1").depends("openssl", "~> 1.0.0") + graph.artifact("mysql", "1.2.4-alpha.1").depends("openssl", "~> 1.0.0") Dependencies can be chained, too - graph.artifacts("ntp", "1.0.0").depends("build-essential").depends("yum") + graph.artifact("ntp", "1.0.0").depends("build-essential").depends("yum") And now solve the graph with some demands Solve.it!(graph, ['nginx', '>= 0.100.0']) Or, if you want a topologically sorted solution NOTE: This will raise Solve::Errors::UnsortableSolutionError if the solution contains a cycle (which can happen with ruby packages) Solve.it!(graph, ['nginx', '>= 0.100.0'], sorted: true) - -### Removing an artifact, or dependency from the graph - - graph.artifacts("nginx", "1.0.0").delete - - artifact.dependencies("nginx", "~> 1.0.0").delete ## Authors * [Jamie Winsor](https://github.com/reset) (<jamie@vialstudios.com>) * [Andrew Garson](andrewGarson) (<agarson@riotgames.com>)