README.md in codependency-2.0.0 vs README.md in codependency-2.1.0
- old
+ new
@@ -1,8 +1,10 @@
# Codependency
-Codependency is a simple comment-based dependency graph that you can use on arbitrary files.
+Codependency is a simple comment-based dependency graph that you can use on
+arbitrary files. The comment syntax should look familiar to anyone who has
+used Sprockets, but is not nearly as robust (yet).
## Installation
Add this line to your application's Gemfile:
@@ -41,10 +43,11 @@
Then, we create a dependency graph to determine the order in which the files might need to be loaded, inserted, or compiled:
``` rb
graph = Codependency::Graph.new
graph.path << '.' # works like PATH, append search paths for this graph
-graph.files # => ["./foo.rb", "./bar.rb"] # returns a topologically sorted list of relative filepaths
+graph << 'bar' # adds a file to this graph, finds its dependencies recursively
+graph.files # returns a topologically sorted list of relative pathnames
```
## Contributing
1. Fork it