Skip to content

Commit

Permalink
deps updated, factory method for creating tags and getLastTag()
Browse files Browse the repository at this point in the history
  • Loading branch information
matteosister committed Apr 22, 2013
1 parent 63007d7 commit 1c75677
Show file tree
Hide file tree
Showing 7 changed files with 387 additions and 28 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,22 @@ Watch a [simple live example](http://gitelephant.cypresslab.net) of what you can

[Download the demo bundle code](https://github.com/matteosister/GitElephantDemoBundle) used in the live example

How it works
------------

GitElephant mostly rely on the git binary to retrieve information about the repository, read the output and create an OOP layer to interact with

Some parts are (or will be) implemented by reading directly inside the .git folder

The api is completely transparent to the end user. You don't have to worry about which method is used.

Requirements
------------

- php >= 5.3
- php >= 5.3.0
- *nix system with git installed

I work on an ubuntu box, but the lib should work well with every unix system.
I work on linux, but the lib should work well with every unix system, as far as a git binary is available.
I don't have a windows installation to test...if someone want to help...

Installation
Expand Down Expand Up @@ -89,6 +98,10 @@ $repo->getBranch('master'); // return a TreeBranch instance by its name
// tags
$repo->getTags(); // array of TreeTag instances
$repo->getTag('v1.0'); // a TreeTag instance by name
TreeTag::pick($repo, 'v1.0'); // a TreeTag instance by name

// last tag by date
$repo->getLastTag();

// commit
$repo->getCommit(); // get a Commit instance of the current HEAD
Expand Down Expand Up @@ -296,6 +309,7 @@ Dependencies

- [symfony/process](https://packagist.org/packages/symfony/process)
- [symfony/filesystem](https://packagist.org/packages/symfony/filesystem)
- [symfony/finder](https://packagist.org/packages/symfony/finder)

*for tests*

Expand Down
2 changes: 0 additions & 2 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,3 @@ todo
* blobs management
* submodules management

Next
* introduce traits and make the library php 5.4 only?
6 changes: 4 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@
"require": {
"php": ">=5.3.0",
"symfony/process": ">=2.1,<2.3-dev",
"symfony/filesystem": ">=2.1,<2.3-dev"
"symfony/filesystem": ">=2.1,<2.3-dev",
"symfony/finder": ">=2.1,<2.3-dev"
},
"require-dev": {
"phpunit/phpunit": "@stable"
"phpunit/phpunit": "@stable",
"sami/sami": "dev-master"
},
"minimum-stability": "stable",
"autoload": {
Expand Down
Loading

0 comments on commit 1c75677

Please sign in to comment.