summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index 2dd268ef87d..1cab5c19390 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,21 @@
-For information about contributing to GlusterFS, please follow [Contributing to GlusterFS community](https://gluster.readthedocs.io/en/latest/Developer-guide/Developers-Index/#contributing-to-the-gluster-community).
+# Gluster
+ Gluster is a software defined distributed storage that can scale to several
+ petabytes. It provides interfaces for object, block and file storage.
-*GlusterFS does not follow the [GitHub: Fork & pull](https://help.github.com/articles/using-pull-requests/) workflow but use [Gerrit](http://review.gluster.org) for code review.*
+## Development
+ Contributions to gluster in the form of patches and new feature additions can
+ be made by following steps outlined at [Developers Guide](https://gluster.readthedocs.io/en/latest/Developer-guide/Developers-Index/#contributing-to-the-gluster-community).
-The development guidelines are detailed in [Development Workflow](https://gluster.readthedocs.io/en/latest/Developer-guide/Simplified-Development-Workflow).
+## Documentation
+ The Gluster documentation can be found at [Gluster Docs](http://gluster.readthedocs.io/en/latest).
-The GlusterFS documentation can be found at [our Read the Docs site](http://gluster.readthedocs.io/en/latest).
+## Deployment
+ Quick instructions to build and install can be found in [INSTALL](INSTALL) file.
-For more info, please visit [gluster.org](http://www.gluster.org/).
+## Maintainers
+ The list of Gluster maintainers is available in [MAINTAINERS](MAINTAINERS) file.
+
+## License
+ Gluster is dual licensed under [GPLV2](COPYING-GPLV2) and [LGPLV3+](COPYING-LGPLV3).
+
+ Please visit the [Gluster Home Page](http://www.gluster.org/) to find out more about Gluster.