Permalink
Browse files

A little bit more information in the README.md

  • Loading branch information...
1 parent a26465d commit 93546e5a52b714f3090a4d91865f3b3f676d5c78 @yrashk yrashk committed Jan 27, 2011
Showing with 28 additions and 0 deletions.
  1. +28 −0 README.md
View
28 README.md
@@ -3,6 +3,34 @@ Agner
Agner is a rebar-friendly Erlang package index inspired by Clojars and Homebrew.
+Package names
+-------------
+
+Package name is just either a package name such as <code>mochiweb</code>, or (in case of github indeces, it might also
+take a form of <code>account/package</code>, for example <code>yrashk/misultin</code>)
+
+Versions
+--------
+
+Agner has two kinds of versions:
+
+* Release versions, normally something like <code>1.2.0</code>, represented using tags in .agner repos
+* Flavour versions, normally something like <code>@release</code>, represented using branches in .agner repos
+
+Commands
+--------
+
+ agner list [-d/--descriptions]
+
+
+ agner spec [package name] [-v/--version package_version]
+
+
+ agner fetch [package name] [destination directory] [-v/--version package_version]
+
+ agner versions [package name]
+
+
Rebar
-----

0 comments on commit 93546e5

Please sign in to comment.