Prepare CHANGELOG and README files

This commit is contained in:
Zafar Khaja 2015-03-19 20:38:27 +02:00
parent 06a7320e80
commit 9d28d182cd
3 changed files with 24 additions and 17 deletions

View File

@ -1,18 +1,25 @@
Java SemVer Changelog
=====================
### 0.9.0 (Mar 19, 2015) ###
* [[#7](https://github.com/zafarkhaja/jsemver/issues/6)] Implemented internal DSL for the SemVer Expressions and Ranges
* [[PR#18](https://github.com/zafarkhaja/jsemver/pull/18)] Introduced partial compatibility with `node-semver` ranges
* Reworked the BNF grammar of the SemVer Expressions
* Made some enhancements and improvements
* Updated project dependencies and Maven plugins
### 0.8.0 (Aug 18, 2014) ###
* Rearranged exceptions hierarchy
* Refactored `VersionParser` and `ExpressionParser`
* [[#7](https://github.com/zafarkhaja/java-semver/issues/7)] Improved error handling and error reporting in the Parsers
* [[#7](https://github.com/zafarkhaja/jsemver/issues/7)] Improved error handling and error reporting in the Parsers
* Made some minor improvements and bug fixes
* Updated the `README` file with the "Exception Handling" section
### 0.7.2 (Dec 30, 2013) ###
* [[#8](https://github.com/zafarkhaja/java-semver/issues/8)] Fixed `Version.hashCode()` to comply with `Version.equals()`
* [[#8](https://github.com/zafarkhaja/jsemver/issues/8)] Fixed `Version.hashCode()` to comply with `Version.equals()`
### 0.7.1 (Dec 01, 2013) ###
* [[#5](https://github.com/zafarkhaja/java-semver/issues/5)] Got rid of 'unchecked' warnings
* [[#5](https://github.com/zafarkhaja/jsemver/issues/5)] Got rid of 'unchecked' warnings
* Made minor Javadoc corrections
* Made small code improvements
* Configured `maven-compiler-plugin` to show all warnings
@ -20,9 +27,9 @@ Java SemVer Changelog
### 0.7.0 (Nov 16, 2013) ###
* Adapted the library to the SemVer 2.0.0
* [[#1](https://github.com/zafarkhaja/java-semver/issues/1)] Created the SemVer Expressions Parser
* [[#2](https://github.com/zafarkhaja/java-semver/issues/2)] Added Javadoc to the source code
* [[#4](https://github.com/zafarkhaja/java-semver/issues/4)] Deployed to the Maven Central Repository
* [[#1](https://github.com/zafarkhaja/jsemver/issues/1)] Created the SemVer Expressions Parser
* [[#2](https://github.com/zafarkhaja/jsemver/issues/2)] Added Javadoc to the source code
* [[#4](https://github.com/zafarkhaja/jsemver/issues/4)] Deployed to the Maven Central Repository
* Implemented a parser instead of RegExps for the version parsing
* Created the `MetadataVersion.NULL` object, refactored
* Made some refactoring and minor improvements to the code

View File

@ -1,5 +1,5 @@
Java SemVer v0.8.0 (SemVer 2) [![Build Status](https://travis-ci.org/zafarkhaja/java-semver.png)](https://travis-ci.org/zafarkhaja/java-semver)
=============================
Java SemVer v0.9.0 (SemVer 2) [![Build Status](https://travis-ci.org/zafarkhaja/jsemver.png)](https://travis-ci.org/zafarkhaja/jsemver)
============================
Java SemVer is a Java implementation of the Semantic Versioning Specification
(http://semver.org/).
@ -33,7 +33,7 @@ project.
<dependency>
<groupId>com.github.zafarkhaja</groupId>
<artifactId>java-semver</artifactId>
<version>0.8.0</version>
<version>0.9.0</version>
</dependency>
~~~
@ -42,7 +42,7 @@ project.
<dependency>
<groupId>com.github.zafarkhaja</groupId>
<artifactId>java-semver</artifactId>
<version>0.9.0-SNAPSHOT</version>
<version>0.10.0-SNAPSHOT</version>
</dependency>
~~~
**NOTE**: To use the development version you need to add the SNAPSHOT repository
@ -250,7 +250,7 @@ boolean result = v.satisfies(gte("1.0.0").and(lt("2.0.0"))); // false
### External DSL ###
The BNF grammar for the external DSL can be found in the corresponding
[issue](https://github.com/zafarkhaja/java-semver/issues/1).
[issue](https://github.com/zafarkhaja/jsemver/issues/1).
~~~ java
import com.github.zafarkhaja.semver.Version;
@ -288,7 +288,7 @@ There are two types of errors that may arrise while using Java SemVer
Bugs and Features
-----------------
Bug reports and feature requests can be submitted at https://github.com/zafarkhaja/java-semver/issues.
Bug reports and feature requests can be submitted at https://github.com/zafarkhaja/jsemver/issues.
License

10
pom.xml
View File

@ -15,7 +15,7 @@
<name>Java SemVer</name>
<description>Java implementation of the SemVer Specification</description>
<url>https://github.com/zafarkhaja/java-semver</url>
<url>https://github.com/zafarkhaja/jsemver</url>
<licenses>
<license>
@ -30,14 +30,14 @@
<id>zafarkhaja</id>
<name>Zafar Khaja</name>
<email>zafarkhaja@gmail.com</email>
<timezone>+4</timezone>
<timezone>+3</timezone>
</developer>
</developers>
<scm>
<url>https://github.com/zafarkhaja/java-semver</url>
<connection>scm:git:git://github.com/zafarkhaja/java-semver.git</connection>
<developerConnection>scm:git:ssh://git@github.com/zafarkhaja/java-semver.git</developerConnection>
<url>https://github.com/zafarkhaja/jsemver</url>
<connection>scm:git:git://github.com/zafarkhaja/jsemver.git</connection>
<developerConnection>scm:git:ssh://git@github.com/zafarkhaja/jsemver.git</developerConnection>
</scm>
<dependencies>