Merge pull request #18 from codacy/add-version-to-readme

Add version to readme

Author: rtfpessoa

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# How to contribute
+
+## Main rules
+
+* Before you open a ticket or send a pull request, [search](https://github.com/codacy/codacy-plugins-api/issues) for previous discussions about the same feature or issue. Add any new details to earlier tickets if you find any.
+
+* If you're proposing a new feature, make sure you create an issue to let other contributors know what you will be working on.
+
+* Before sending a pull request make sure your code is tested.
+
+* Before sending a pull request for a feature, be sure to run tests with `./scripts/test.sh`.
+
+* Use the same coding style as the rest of the codebase, most of the checks can be performed with `./scripts/lint.sh`.
+
+* Use `git rebase` (not `git merge`) to sync your work from time to time with the master branch.
+
+* After creating your pull request make sure the build is passing on [CircleCI](https://circleci.com/gh/codacy/codacy-plugins-api) and that [Codacy](https://www.codacy.com/app/Codacy/codacy-plugins-api) is also confident in the code quality.
+
+## Commit Style
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+Follow these guidelines when writing one:
+
+1. The first line should be 50 characters or less and contain a short
+   description of the change prefixed with the name of the changed
+   subsystem (e.g. "net: add localAddress and localPort to Socket").
+2. Keep the second line blank.
+3. Wrap all other lines at 72 columns.
+
+A good commit log can look something like this:
+
+```git-commit
+subsystem: explaining the commit in one line
+
+Body of commit message is a few lines of text, explaining things
+in more detail, possibly giving some background about the issue
+being fixed, etc. etc.
+
+The body of the commit message can be several paragraphs, and
+please do proper word-wrap and keep columns shorter than about
+72 characters or so. That way `git log` will show things
+nicely even when it is indented.
+```
+
+### Developer's Certificate of Origin 1.0
+
+By making a contribution to this project, I certify that:
+
+* (a) The contribution was created in whole or in part by me and I
+  have the right to submit it under the open source license indicated
+  in the file; or
+* (b) The contribution is based upon previous work that, to the best
+  of my knowledge, is covered under an appropriate open source license
+  and I have the right under that license to submit that work with
+  modifications, whether created in whole or in part by me, under the
+  same open source license (unless I am permitted to submit under a
+  different license), as indicated in the file; or
+* (c) The contribution was provided directly to me by some other
+  person who certified (a), (b) or (c) and I have not modified it.

README.md

@@ -3,27 +3,31 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/23d335c474ce4317ad35b19cb90a1f35)](https://www.codacy.com/app/Codacy/codacy-plugins-api?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-plugins-api&utm_campaign=Badge_Grade)
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/23d335c474ce4317ad35b19cb90a1f35)](https://www.codacy.com/app/Codacy/codacy-plugins-api?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-plugins-api&utm_campaign=Badge_Coverage)
 [![CircleCI](https://circleci.com/gh/codacy/codacy-plugins-api.svg?style=svg)](https://circleci.com/gh/codacy/codacy-plugins-api)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.codacy/codacy-plugins-api_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.codacy/codacy-plugins-api_2.12)
 
 A dependency free api for codacy-engines
 
-This repository is ment to be the interface between 
-.) codacy engines (currently via https://github.com/codacy/codacy-engine-scala-seed), 
-.) the plugins-test and
-.) codacy's internal component running engines and picking up their results
+This repository is meant to be the interface between
 
-it's held dependency free so we are flexible on changing (versions of) mainly json-libraries on the components that use it.
+* Codacy analysis tools (currently via [codacy-engine-scala-seed](https://github.com/codacy/codacy-engine-scala-seed))
+* Codacy duplication tools (currently via [codacy-duplication-scala-seed](https://github.com/codacy/codacy-duplication-scala-seed))
+* Codacy metrics tools (currently via [codacy-metrics-scala-seed](https://github.com/codacy/codacy-metrics-scala-seed))
+* The tests with [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test)
+* Codacy's internal component running tools and picking up their results
 
-## What is Codacy?
+It's held dependency free so we are flexible on changing (versions of) mainly json-libraries on the components that use it.
+
+## What is Codacy
 
 [Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
 
-### Among Codacy’s features:
+### Among Codacy’s features
 
-- Identify new Static Analysis issues
-- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
-- Auto-comments on Commits and Pull Requests
-- Integrations with Slack, HipChat, Jira, YouTrack
-- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories
+* Identify new Static Analysis issues
+* Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
+* Auto-comments on Commits and Pull Requests
+* Integrations with Slack, HipChat, Jira, YouTrack
+* Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories
 
 Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.