Commit f206ba6c authored by Vincent Driessen's avatar Vincent Driessen

Update README file to match the 0.1 release status.

parent caa5830a
......@@ -4,29 +4,51 @@ A collection of Git wrapper scripts to provide high-level repository operations
for Vincent Driessen's [branching model](http://nvie.com/archives/323 "original
blog post").
Please help out
---------------
This project is yet unimplemented. And yes, I mean unimplemented. There are no
scripts yet, but I will use this README file as the "design document" for now,
so people may start collaborating on it.
Feel free to fork this repo and to commit your additions.
Release 0.1
-----------
A quick release of version 0.1 has arrived. The main script are functional and
should be usable under "normal" use.
There have barely been any real-world tests, but I encourage you to start using
it actively. [Feedback](http://github.com/nvie/gitflow/issues) is also very
welcome. See the "Please help out" section below, also.
**Make sure to validate the modifications to your repo after running any of the
`gitflow` commands, before pushing them permanently.**
Installing gitflow
------------------
There isn't a real Unix installer available, but the project is so small that
installing it is easy.
Commands
--------
Initially, the following subcommands to `gitflow` should be created:
Either:
* `start`
* `finish`
- Put the `gitflow` directory anywhere on your Unix `PATH` variable; or
- Run:
Those subcommands could work on branch types:
$ git clone git://github.com/nvie/gitflow
$ cd gitflow
$ cp gitflow* /usr/local/bin
Please help out
---------------
This project is still under development. What is available today is merely its
foundation. However, it is functional in its current form and should be usable
under normal use. (Don't try to create multiple release branches next to each
other and stuff like that, yet.)
Feedback and suggestions are very welcome and I encourage you to use the
[Issues list](http://github.com/nvie/gitflow/issues) on Github to provide that
feedback.
Feel free to fork this repo and to commit your additions.
* `feature`
* `release`
* `hotfix`
Examples
--------
Example uses:
-------------
* To start a new feature branch, use:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment