Skip to content

Commit 033a620

Browse files
committed
updated readme
1 parent e8eba13 commit 033a620

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Swagger Core library
22

3-
[![Build Status](https://travis-ci.org/swagger-api/swagger-core.svg?branch=develop_2.0)](https://travis-ci.org/swagger-api/swagger-core)
3+
[![Build Status](https://travis-ci.org/swagger-api/swagger-core.svg?branch=master)](https://travis-ci.org/swagger-api/swagger-core)
44

55
The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service.
66

7-
Swagger-core is the Java implementation of Swagger. Current version supports *JAX-RS*. Future milestone releases will add support for *plain Servlets* and *Play Framework*.
7+
Swagger-core is the Java implementation of Swagger. Current version supports *JAX-RS*. Future milestone releases will add support for *plain Servlets* and *Play Framework*.
88

99
Check out [Swagger-Spec](https://github.com/swagger-api/swagger-spec) for additional information about the Swagger project, including additional libraries with support for SpringMVC, other languages and more.
1010

@@ -29,10 +29,10 @@ The Swagger Specification has undergone 3 revisions since initial creation in 20
2929

3030
Swagger core Version | Release Date | Swagger Spec compatibility | Notes | Status
3131
------------------------- | ------------ | -------------------------- | ----- | ----
32-
1.5.0-M2 | 2015-03-30 | 2.0 | [master](https://github.com/swagger-api/swagger-core) |
33-
1.3.12 | 2014-12-23 | 1.2 | [tag v1.3.12](https://github.com/swagger-api/swagger-core/tree/v1.3.12)
34-
1.2.4 | 2013-06-19 | 1.1 | [tag swagger-project_2.10.0-1.2.4](https://github.com/swagger-api/swagger-core/tree/swagger-project_2.10.0-1.2.4)
35-
1.0.0 | 2011-10-16 | 1.0 | [tag v1.0](https://github.com/swagger-api/swagger-core/tree/v1.0)
32+
1.5.0-M2 | 2015-03-30 | 2.0 | [master](https://github.com/swagger-api/swagger-core) | Supported
33+
1.3.12 | 2014-12-23 | 1.2 | [tag v1.3.12](https://github.com/swagger-api/swagger-core/tree/v1.3.12) | Supported
34+
1.2.4 | 2013-06-19 | 1.1 | [tag swagger-project_2.10.0-1.2.4](https://github.com/swagger-api/swagger-core/tree/swagger-project_2.10.0-1.2.4) | Deprecated
35+
1.0.0 | 2011-10-16 | 1.0 | [tag v1.0](https://github.com/swagger-api/swagger-core/tree/v1.0) | Deprecated
3636

3737
## Where is Scala support?
3838
To allow independent development, scala support has been moved into a separate project. See the [swagger-scala-module](https://github.com/swagger-api/swagger-scala-module) for details. Play! framework support is moving outside the swagger-core project as well.
@@ -47,11 +47,10 @@ If you're interested in the change history of swagger and the swagger-core frame
4747
### Prerequisites
4848
You need the following installed and available in your $PATH:
4949

50-
<li>- Java 6 (http://java.oracle.com)
50+
* Java 6 (http://java.oracle.com)
51+
* Apache maven 3.0.4 or greater (http://maven.apache.org/)
52+
* Jackson 2.4.2 or greater
5153

52-
<li>- Apache maven 3.0.4 or greater (http://maven.apache.org/)
53-
54-
<li>- Jackson 2.4.2 or greater
5554

5655
### To build from source (currently 1.5.0-M2)
5756
```
@@ -64,14 +63,18 @@ Subsequent builds:
6463
mvn install
6564
```
6665

67-
This will build the modules and sample apps.
66+
This will build the modules. To build sample apps, activate the `samples` profile:
67+
68+
```
69+
mvn install -Psamples
70+
```
6871

6972
Of course if you don't want to build locally you can grab artifacts from maven central:
7073

7174
`http://repo1.maven.org/maven2/com/wordnik/`
7275

7376
## Sample Apps
74-
There are a number of sample apps in the [samples](https://github.com/swagger-api/swagger-core/tree/develop_2.0/samples) folder.
77+
There are a number of sample apps in the [samples](https://github.com/swagger-api/swagger-core/blob/master/samples) folder.
7578

7679
```
7780

0 commit comments

Comments
 (0)