Skip to content

Commit f206ba6

Browse files
committed
Update README file to match the 0.1 release status.
1 parent caa5830 commit f206ba6

File tree

1 file changed

+39
-17
lines changed

1 file changed

+39
-17
lines changed

README.mdown

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,51 @@ A collection of Git wrapper scripts to provide high-level repository operations
44
for Vincent Driessen's [branching model](http://nvie.com/archives/323 "original
55
blog post").
66

7-
Please help out
8-
---------------
9-
This project is yet unimplemented. And yes, I mean unimplemented. There are no
10-
scripts yet, but I will use this README file as the "design document" for now,
11-
so people may start collaborating on it.
127

13-
Feel free to fork this repo and to commit your additions.
8+
Release 0.1
9+
-----------
10+
A quick release of version 0.1 has arrived. The main script are functional and
11+
should be usable under "normal" use.
12+
13+
There have barely been any real-world tests, but I encourage you to start using
14+
it actively. [Feedback](http://github.com/nvie/gitflow/issues) is also very
15+
welcome. See the "Please help out" section below, also.
16+
17+
**Make sure to validate the modifications to your repo after running any of the
18+
`gitflow` commands, before pushing them permanently.**
19+
20+
21+
Installing gitflow
22+
------------------
23+
There isn't a real Unix installer available, but the project is so small that
24+
installing it is easy.
1425

15-
Commands
16-
--------
17-
Initially, the following subcommands to `gitflow` should be created:
26+
Either:
27+
28+
- Put the `gitflow` directory anywhere on your Unix `PATH` variable; or
29+
- Run:
30+
31+
$ git clone git://github.com/nvie/gitflow
32+
$ cd gitflow
33+
$ cp gitflow* /usr/local/bin
1834

19-
* `start`
20-
* `finish`
2135

22-
Those subcommands could work on branch types:
36+
Please help out
37+
---------------
38+
This project is still under development. What is available today is merely its
39+
foundation. However, it is functional in its current form and should be usable
40+
under normal use. (Don't try to create multiple release branches next to each
41+
other and stuff like that, yet.)
42+
43+
Feedback and suggestions are very welcome and I encourage you to use the
44+
[Issues list](http://github.com/nvie/gitflow/issues) on Github to provide that
45+
feedback.
46+
47+
Feel free to fork this repo and to commit your additions.
2348

24-
* `feature`
25-
* `release`
26-
* `hotfix`
2749

28-
Examples
29-
--------
50+
Example uses:
51+
-------------
3052

3153
* To start a new feature branch, use:
3254

0 commit comments

Comments
 (0)