forks/geef
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: use highlighted code block, talk about elixir

Browse Source
This commit is contained in:
Carlos Martín Nieto
2013-05-13 11:06:37 +02:00
parent 4a2f2e8ab2
commit dfdb4cbb54
1 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -23,14 +23,28 @@ in it.
The API looks basically like this: The API looks basically like this:
{ok, Repo} = geef_repo:open("."). ```erlang
Workdir = geef_repo:workdir(Repo). {ok, Repo} = geef_repo:open(".").
{ok, Blob} = geef_blob:lookup(Repo, geef_oid:parse("abcde...")). Workdir = geef_repo:workdir(Repo).
{ok, Blob} = geef_blob:lookup(Repo, geef_oid:parse("abcde...")).
```
Elixir
======
Some effort is made to let elixir programmers use the library in a
more OO fashion. As an example, you can resolve a reference by calling
a `resolve` method on it.
```elixir
{ :ok, original_ref } = :geef_ref.lookup(repo, refname)
{ :ok, resolved_ref } = original_ref.resolve()
```
CONTRIBUTING CONTRIBUTING
============== ==============
Fork schacon/geef on GitHub, make it awesomer (preferably in a branch named Fork carlosmn/geef on GitHub, make it awesomer (preferably in a branch named
for the topic), send a pull request. for the topic), send a pull request.