[GitHub] [kibble] turbaszek commented on a change in pull request #35: Improve the look of README.md

[GitBox <gi...@apache.org>]

turbaszek commented on a change in pull request #35:
URL: https://github.com/apache/kibble/pull/35#discussion_r501243310



##########
File path: README.md
##########
@@ -1,18 +1,33 @@
-![Logo](/ui/images/kibble-logo.png)
+<p align="center"><img src="/ui/images/kibble-logo.png" width="300"/></p>
 
-# Kibble UI and Database Service
+# Apache Kibble
 
-_Apache Kibble is a suite of tools for collecting, aggregating and
-visualizing activity in software projects._
+Apache Kibble is a tool to collect, aggregate and visualize data about open source projects
+maintained by open source projects. It consists of two components:
+
+- **Kibble Server** (this repository) - main database and UI Server. It serves as the hub
+ for the scanners to connect to, and provides the overall management of sources as well as the
+ visualizations and API end points.
+- **Kibble scanners** ([kibble-scanners](https://github.com/apache/kibble-scanners)) - a collection of
+ scanning applications each designed to work with a specific type of resource (git repo, mailing list, 
+ JIRA, etc) and push compiled data objects to the Kibble Server.
+
+## Documentation
 
 For information about the Kibble project and community, visit our
 web site at [https://kibble.apache.org/](https://kibble.apache.org/).
 
-For an online demo of the Kibble service, see
-[https://demo.kibble.apache.org/](https://demo.kibble.apache.org/).
+## Live demo
+
+If you would love to try Kibble without installing it on your own machine try the online demo of the Kibble
+service: [https://demo.kibble.apache.org/](https://demo.kibble.apache.org/).
+
+
+## Installation
+
+For installation steps see the [documentation](https://apache-kibble.readthedocs.io/en/latest/setup.html#installing-the-server).
 
-See the [documentation](https://apache-kibble.readthedocs.io/) for
-installation, setup and usage instructions.
+## Contributing
 
-This is one component of the Kibble Suite. Please also see the 
-[kibble scanners](https://github.com/apache/kibble-scanners) utility.
+We welcomes all contributions that improve the state of the Apache Kibble project. For contribution guidelines

Review comment:
       ```suggestion
   We welcome all contributions that improve the state of the Apache Kibble project. For contribution guidelines
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org