[TOMEE-2361] Improve main README file

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 8.0.0-M1
• Fix Version/s: 8.0.0-M3
• Component/s: Examples and Documentation
• Labels: pull-request-available
• Assignee: Cesar Hernandez
• Reporter: Roberto Cortez
• Created: 12/Dec/18 22:25
• Updated: 27/Feb/19 02:05
• Resolved: 27/Feb/19 02:05

Description

Right now, our main readme file is very poor:
https://github.com/apache/tomee/blob/master/README.md

I think we should improve it a bit by adding the following information:

• Project description
• Downloads
• Contribution guidelines
• Links to docs with examples or other relevant information
• Links to tools used by the project
• Any other relevant stuff

This may look like a duplication from the website. We can and should link to pieces of information there. On the other hand, people may find the project directly on Github and should have a minimal piece of information to get them started.

Issue Links

• links to: GitHub Pull Request #299