diff --git a/README.md b/README.md index 0624bf9..243c8b8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,40 @@ -gitbucket +GitBucket ========= -Github clone by Scala, Easy to setup. \ No newline at end of file +GitBucket is a Github clone by Scala, Easy to setup. + +The latest version of GitBucket provides a basic features below: + +- Public / Private Git repository (http access only) +- Repository viewer (some advanced features are not implemented) +- Wiki +- Issues +- User management (for Administrators) + +Following features are not implemented, but we will make them in the future release! + +- Fork and pull request +- Timeline +- Search +- Network graph +- Statics +- Watch / Star +- Team management (like Organization in Github) + +If you want to try the development version of GitBucket, see the documentation for developers at [Wiki](https://github.com/takezoe/gitbucket/wiki). + +Instllation +-------- + +1. Download latest **gitbucket.war** from [the release page](https://github.com/takezoe/gitbucket/releases). +2. Deploy it to the servlet container such as Tomcat or Jetty. +3. Access **http://[hostname]:[port]/gitbucket/** using your web browser. + +The default administrator account is **root** and password is **root**. + +Release Notes +-------- + +### 1.0 - 04 Jul 2013 + +- This is a first public release.