Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to README.md #51

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Updates to README.md #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# PHP-Git2 - libgit2 bindings in PHP

php-git2 is a PHP bindings to the libgit2 linkable C Git library.
this extension are re-writing php-git as that code too dirty.
php-git2 is a PHP binding to the libgit2 linkable C Git library.
This extension is a re-writing of php-git as that code was too dirty.

# Important Notice

php-git changed it's API drastically. this changes doesn't care about compatibility between old one.
please check tests cases.
php-git changed it's API drastically. These changes do not care about backward
compatiblity. Please take a look at the tests for examples of the new API.

# Installing And Running

you need to install libgit2 before make php-git.
You need to install libgit2 before you can make php-git.

````
git clone https://github.com/libgit2/php-git.git --recursive
Expand All @@ -28,7 +28,7 @@ sudo make install
# add `extension=git2.so` to your php.ini
````

new php-git features almost tested.
New php-git features are almost tested.

# API

Expand Down Expand Up @@ -161,11 +161,11 @@ bool $odb->exists(sha1)// same as Git2\Repository::exists
````

## Reflog
will be add.
Will be added.

## Remote access (Experimental)

this API will be change.
This API will be changed.

````
$repo = new Git2\Repository("/path/to/.git");
Expand Down