Skip to content

Commit

Permalink
Update docs, add docs for extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
gschueler committed Mar 10, 2020
1 parent 5b71f0d commit f3eaff6
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ This project is now at 1.0.x status.
* [SSL Configuration](https://rundeck.github.io/rundeck-cli/configuration/ssl/)
* [Commands](https://rundeck.github.io/rundeck-cli/commands)
* [Scripting](https://rundeck.github.io/rundeck-cli/scripting)
* [Java API Library](https://rundeck.github.io/rundeck-cli/javalib/)
* [Extensions](https://rundeck.github.io/rundeck-cli/extensions/)

# Javadoc

* [rd-api-client ![javadoc](https://javadoc.io/badge2/org.rundeck.api/rd-api-client/javadoc.svg)](https://javadoc.io/doc/org.rundeck.api/rd-api-client)
* [rd-cli-lib ![javadoc](https://javadoc.io/badge2/org.rundeck.cli/rd-cli-lib/javadoc.svg)](https://javadoc.io/doc/org.rundeck.cli/rd-cli-lib)

# Downloads

Expand Down
11 changes: 7 additions & 4 deletions docs/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,19 @@ You can check the list of loaded extensions by running `rd` with `RD_DEBUG=1`.

Extensions can be developed as Java libraries.


### Dependencies

Add the `rd-cli-lib` dependency to your project.

Available in Jcenter repo or [Bintray](https://bintray.com/rundeck/maven/rd-cli-lib).

Javadoc:

* [rd-cli-lib ![javadoc](https://javadoc.io/badge2/org.rundeck.cli/rd-cli-lib/javadoc.svg)](https://javadoc.io/doc/org.rundeck.cli/rd-cli-lib)
* [cli-toolbelt ![cli-toolbelt](https://javadoc.io/badge2/org.rundeck.cli-toolbelt/toolbelt/javadoc.svg)](https://javadoc.io/doc/org.rundeck.cli-toolbelt/toolbelt)


### Gradle example

A demo project can be seen here: <https://github.com/gschueler/rd-extension-demo>
Expand Down Expand Up @@ -96,7 +103,3 @@ Declare your class in a file called `META-INF/services/org.rundeck.client.tool.e
com.mycompany.MyClass

For a standard Gradle java library, create the file in `src/main/resources/META-INF/services/org.rundeck.client.tool.extension.RdCommandExtension`

## Javadoc

(to be published)
6 changes: 3 additions & 3 deletions docs/javalib.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Currently the library is published to Bintray (jcenter/maven central TBD).

See: <https://bintray.com/rundeck/maven/rd-api-client>

Javadoc:
* [rd-api-client ![javadoc](https://javadoc.io/badge2/org.rundeck.api/rd-api-client/javadoc.svg)](https://javadoc.io/doc/org.rundeck.api/rd-api-client)

## Gradle usage

A demo project can be seen here: <https://github.com/gschueler/rd-api-demo>
Expand All @@ -32,6 +35,3 @@ dependencies {
}
~~~

## Javadoc

(to be published)

0 comments on commit f3eaff6

Please sign in to comment.