Skip to content

Commit

Permalink
[readme] Fix readme links and improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jludvice committed Jun 18, 2017
1 parent 80bed74 commit c3636b8
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Camel ISDS Component
=======================
[![Build Status](https://travis-ci.org/czgov/camel-isds.svg?branch=master)](https://travis-ci.org/czgov/camel-isds)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.czgov/camel-isds/badge.svg)](https://maven-badges.herokuapp.com/maven-central/cz.abclinuxu.datoveschranky/isds)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.czgov/camel-isds/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.czgov/camel-isds)
[![Javadocs](http://javadoc.io/badge/com.github.czgov/camel-isds.svg)](http://javadoc.io/doc/com.github.czgov/camel-isds)


Expand All @@ -21,7 +21,7 @@ from("isds:messages?environment=test&username=YOUR_LOGIN&password=YOUR_PASSWORD?
.to("file:dir-with-zfo-files");
```

See component documentation [here](src/main/docs/isds.adoc).
**See component documentation [here](src/main/docs/isds.adoc).**


## OSGi ready
Expand Down
38 changes: 36 additions & 2 deletions src/main/docs/isds.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,46 @@ for this component:
[source,xml]
-------------------------------------------------------
<dependency>
<groupId>com.github.czgov.isds</groupId>
<groupId>com.github.czgov</groupId>
<artifactId>camel-isds</artifactId>
<version>0.1.0-SNAPSHOT</version>
<version>${use.latest.from.maven.central}</version>
</dependency>
-------------------------------------------------------

The recomended approach is to use some BOM (Bill of Materials)
to avoid version conflicts.
There is https://issues.apache.org/jira/browse/CAMEL-8502[issue]
for real BOM in Camel project but `camel-parent` can be used until then.

[source,xml]
-------------------------------------------------------
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-parent</artifactId>
<version>${camel.version</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-core</artifactId>
</dependency>
<dependency>
<groupId>com.github.czgov</groupId>
<artifactId>camel-isds</artifactId>
<version>${use.latest.from.maven.central}</version>
</dependency>
</dependencies>
-------------------------------------------------------


### URI format
[source,java]
----
Expand Down

0 comments on commit c3636b8

Please sign in to comment.