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

Update README

Browse Source 
Show more capabilities of the elixir part
This commit is contained in:
Carlos Martín Nieto
2013-07-12 18:38:18 +02:00
parent ff4eb2301a
commit ed6654fe59
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -33,24 +33,25 @@ Workdir = geef_repo:workdir(Repo).
Elixir Elixir
====== ======
There are wrappers for elixir which make use of some elixir-specific Most functions are available from the elixir modules so you can make use of some elixir-specific
things, like `Repository.open!`, or `Reference.resolve!`. things, like `Repository.open!`, or `Reference.resolve!`.
```elixir ```elixir
alias Geef.Repository alias Geef.Repository
alias Geef.Reference alias Geef.Reference
repo = Repository.open!(".") repo = Repository.open!(".")
ref = Reference.lookup!(repo. "HEAD") |> Reference.resolve! ref = Reference.lookup!(repo, "HEAD") |> Reference.resolve!
``` ```
Of course, you could also do references, objects, etc are elixir records. Trees implement the Access protocol
```elixir ```elixir
ref = Repository.open! "." |> Reference.lookup! "HEAD" |> Reference.resolve! Reference[name: name] = Reference.lookup!(repo, "refs/heads/master")
IO.puts name
{:ok, tree} = Tree.lookup(repo, "abcde...")
IO.inspect tree["src/geef_pkt.erl"]
``` ```
but then you would leak the repository process.
CONTRIBUTING CONTRIBUTING
============== ==============
@@ -61,8 +62,8 @@ for the topic), send a pull request.
AUTHORS AUTHORS
============== ==============
Scott Chacon <schacon@gmail.com> * Carlos Martín Nieto <cmn@dwim.me>
Carlos Martín Nieto <cmn@dwim.me> * Scott Chacon <schacon@gmail.com>
LICENSE LICENSE