weslien · October 13, 2015 12:23 · Oct 13, 2015 · Oct 13, 2015 · Oct 13, 2015 · Oct 13, 2015
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Helper library for calculations related to odds.
 ## Code Example
 
 ```java
-import com.betsson.odds.OddsCalculator;
+import com.company.odds.OddsCalculator;
 
 ...
 
@@ -28,7 +28,7 @@ Collect all operations related to odds in one place to control how calculations
 
 ```Gradle
 dependencies {
-    compile group: 'betsson', name: 'odds', version: '0.1.7'
+    compile group: 'company', name: 'odds', version: '0.1.7'
 }
 
 ```
@@ -40,7 +40,7 @@ dependencies {
   ...
   <dependencies>
     <dependency>
-      <groupId>betsson</groupId>
+      <groupId>company</groupId>
       <artifactId>odds</artifactId>
       <version>0.1.7</version>
     </dependency>

diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ Calculates the basic odds given possible and desirable number of outcomes
 
 ## Tests
 
-```
+```Bash
 > gradle test
 
 ```

diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ Collect all operations related to odds in one place to control how calculations
 
 ### Gradle
 
-```Json
+```Gradle
 dependencies {
     compile group: 'betsson', name: 'odds', version: '0.1.7'
 }

diff --git a/README.md b/README.md
@@ -1,31 +1,79 @@
+# Odds calculator
+
 ## Synopsis
 
-At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
+Helper library for calculations related to odds.
 
 ## Code Example
 
-Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
+```java
+import com.betsson.odds.OddsCalculator;
+
+...
+
+float combinedOdds = OddsCalculator.combine(oddsA, oddsB, oddsC);
+float basicOdds = OddsCalculator.basic(nrPossibleOutcomes, nrFavorableOutcomes);
+
+...
+
+```
 
 ## Motivation
 
-A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.
+Collect all operations related to odds in one place to control how calculations are performed across the company
 
 ## Installation
 
-Provide code examples and explanations of how to get the project.
+### Gradle
+
+```Json
+dependencies {
+    compile group: 'betsson', name: 'odds', version: '0.1.7'
+}
+
+```
+
+### Maven
+
+```XML
+<project>
+  ...
+  <dependencies>
+    <dependency>
+      <groupId>betsson</groupId>
+      <artifactId>odds</artifactId>
+      <version>0.1.7</version>
+    </dependency>
+  </dependencies>
+</project>
+```
 
 ## API Reference
 
-Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
+### combine(float ... floats)
+Takes an arbitrary list of odds and returns the combined odds
+
+### basic(float possible, float desirable)
+Calculates the basic odds given possible and desirable number of outcomes
 
 ## Tests
 
-Describe and show how to run the tests with code examples.
+```
+> gradle test
+
+```
 
 ## Contributors
 
-Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
+Link to Jira accounts here
+
+### Do you want to contribute?
+- Fork this repository in Stash
+- Create a feature branch
+- Make your changes
+- Submit a pull request back to master branch and add at least 2 core contributors as reviewers
+
 
-## License
+## History
 
-A short snippet describing the license (MIT, Apache, etc.)
+Changelog here
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## Synopsis
 
-At the top of the file there should be a short introduction and/ or overveiw that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
+At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
 
 ## Code Example
 

diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+## Synopsis
+
+At the top of the file there should be a short introduction and/ or overveiw that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
+
+## Code Example
+
+Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
+
+## Motivation
+
+A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.
+
+## Installation
+
+Provide code examples and explanations of how to get the project.
+
+## API Reference
+
+Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
+
+## Tests
+
+Describe and show how to run the tests with code examples.
+
+## Contributors
+
+Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
+
+## License
+
+A short snippet describing the license (MIT, Apache, etc.)
No results found