Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 54 lines (32 sloc) 1.649 kb
2f3d20a @yrashk Added README.md
yrashk authored
1 Agner
2 =====
3
504775b @yrashk A little bit more of information on what Agner is.
yrashk authored
4 Agner is a rebar-friendly Erlang package index inspired by Clojars and Homebrew.
5
6 Essentially, Agner is an index of Erlang packages with some extra capabilities such as versioning, downloads and so on.
2f3d20a @yrashk Added README.md
yrashk authored
7
93546e5 @yrashk A little bit more information in the README.md
yrashk authored
8 Package names
9 -------------
10
f4ea6b1 @yrashk Typo fix in README.md
yrashk authored
11 Package name is just either a package name such as <code>mochiweb</code>, or (in case of github indices, it might also
93546e5 @yrashk A little bit more information in the README.md
yrashk authored
12 take a form of <code>account/package</code>, for example <code>yrashk/misultin</code>)
13
14 Versions
15 --------
16
17 Agner has two kinds of versions:
18
19 * Release versions, normally something like <code>1.2.0</code>, represented using tags in .agner repos
20 * Flavour versions, normally something like <code>@release</code>, represented using branches in .agner repos
21
22 Commands
23 --------
24
25 agner list [-d/--descriptions]
26
27 agner spec [package name] [-v/--version package_version]
28
29 agner fetch [package name] [destination directory] [-v/--version package_version]
30
31 agner versions [package name]
32
33
2f3d20a @yrashk Added README.md
yrashk authored
34 Rebar
35 -----
36
53e5d8c @yrashk Fixed another link in README.md
yrashk authored
37 Agner-compatible rebar is available at [agner branch](https://github.com/agner/rebar/tree/agner) of [agner/rebar](https://github.com/agner/rebar). Or you can download ready-made rebar from [agner itself](https://github.com/agner/agner/raw/master/rebar).
2f3d20a @yrashk Added README.md
yrashk authored
38
39 Using it with rebar is fairly simple, it uses rebar's deps feature:
40
a26465d @yrashk Markup update in README.md
yrashk authored
41 {deps, [
42 {typespecs, "0.1", {agner, "typespecs"}},
43 {getopt, "0.3.0", {agner, "getopt"}}
44 ]}.
2f3d20a @yrashk Added README.md
yrashk authored
45
fec3baa @yrashk Typo fix
yrashk authored
46 You can also specify your own indices:
2f3d20a @yrashk Added README.md
yrashk authored
47
a26465d @yrashk Markup update in README.md
yrashk authored
48 {agner_indices, [{github, "yourgithubusername"},{github,"agner"}].
2f3d20a @yrashk Added README.md
yrashk authored
49
ca3ad6d @yrashk Added Contributing article link to README.md
yrashk authored
50 Contributing
51 ------------
52
f4ea6b1 @yrashk Typo fix in README.md
yrashk authored
53 Please read at the [wiki](https://github.com/agner/agner/wiki/Contributing).
Something went wrong with that request. Please try again.