Skip to content

Commit c918c44

Browse files
committed
Update adocs.
1 parent 71b0c20 commit c918c44

File tree

2 files changed

+104
-26
lines changed

2 files changed

+104
-26
lines changed

README.adoc

Lines changed: 101 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,101 @@
1-
= kotlin-html-dsl image:https://travis-ci.org/daggerok/kotlin-html-dsl.svg?branch=master["Build Status", link="https://travis-ci.org/daggerok/kotlin-html-dsl"]
2-
3-
//tag::content[]
4-
image:https://travis-ci.org/daggerok/kotlin-html-dsl.svg?branch=master["Build Status", link="https://travis-ci.org/daggerok/kotlin-html-dsl"]
5-
image:https://api.bintray.com/packages/daggerok/daggerok/kotlin-html-dsl/images/download.svg[link="https://bintray.com/bintray/jcenter?filterByPkgName=kotlin-html-dsl"]
6-
image:https://jitpack.io/v/daggerok/kotlin-html-dsl.svg["JitPack", link="https://jitpack.io/#daggerok/kotlin-html-dsl"]
7-
8-
== description
9-
Simple and small Kotlin HTML DSL library.
10-
Could be used to build server-side MVC apps
11-
12-
image:https://www.bintray.com/docs/images/bintray_badge_color.png["kotlin-html-dsl", link="https://bintray.com/daggerok/daggerok/kotlin-html-dsl?source=watch"]
13-
14-
.build
15-
----
16-
# maven:
17-
./mvnw
18-
19-
# or gradle:
20-
./gradlew
21-
----
22-
23-
read more link:./BINTRAY.adoc[here] and link:./JITPACK.adoc[here]
24-
25-
generated by link:https://github.com/daggerok/generator-jvm/[jvm] yeoman generator
26-
//end::content[]
1+
= kotlin-html-dsl image:https://travis-ci.org/daggerok/kotlin-html-dsl.svg?branch=master["Build Status", link="https://travis-ci.org/daggerok/kotlin-html-dsl"]
2+
3+
//tag::content[]
4+
image:https://travis-ci.org/daggerok/kotlin-html-dsl.svg?branch=master["Build Status", link="https://travis-ci.org/daggerok/kotlin-html-dsl"]
5+
image:https://api.bintray.com/packages/daggerok/daggerok/kotlin-html-dsl/images/download.svg[link="https://bintray.com/bintray/jcenter?filterByPkgName=kotlin-html-dsl"]
6+
image:https://jitpack.io/v/daggerok/kotlin-html-dsl.svg["JitPack", link="https://jitpack.io/#daggerok/kotlin-html-dsl"]
7+
8+
== description
9+
Simple and small Kotlin HTML DSL library.
10+
Could be used to build server-side MVC apps
11+
12+
image:https://www.bintray.com/docs/images/bintray_badge_color.png["kotlin-html-dsl", link="https://bintray.com/daggerok/daggerok/kotlin-html-dsl?source=watch"]
13+
14+
== other installation variants
15+
=== gradle bintray.daggerok
16+
.gradle setup (build.gradle)
17+
[source,gradle]
18+
----
19+
repositories {
20+
maven { url "https://dl.bintray.com/daggerok/daggerok" }
21+
}
22+
23+
dependencies {
24+
compile "com.github.daggerok:daggerok-context:0.0.1"
25+
}
26+
----
27+
=== gradle jitpack
28+
.gradle setup (build.gradle)
29+
[source,gradle]
30+
----
31+
repositories {
32+
maven { url "https://jitpack.io" }
33+
}
34+
35+
dependencies {
36+
compile "com.github.daggerok:daggerok-context:0.0.1"
37+
}
38+
----
39+
=== maven bintray/daggerok
40+
.maven setup (pom.xml)
41+
[source,xml]
42+
----
43+
<repositories>
44+
<repository>
45+
<id>bintray-daggerok-daggerok</id>
46+
<url>https://dl.bintray.com/daggerok/daggerok</url>
47+
</repository>
48+
</repositories>
49+
50+
<dependencies>
51+
<dependency>
52+
<groupId>com.github.daggerok</groupId>
53+
<artifactId>daggerok-context</artifactId>
54+
<version>0.0.1</version>
55+
</dependency>
56+
</dependencies>
57+
----
58+
=== maven jitpack
59+
.maven setup (pom.xml)
60+
[source,xml]
61+
----
62+
<repositories>
63+
<repository>
64+
<id>jitpack.io</id>
65+
<url>https://jitpack.io</url>
66+
</repository>
67+
</repositories>
68+
69+
<dependencies>
70+
<dependency>
71+
<groupId>com.github.daggerok</groupId>
72+
<artifactId>daggerok-context</artifactId>
73+
<version>0.0.1</version>
74+
</dependency>
75+
</dependencies>
76+
----
77+
78+
== TODO
79+
* add examples projects
80+
* publish to mavenCentral (TODO)
81+
82+
== contribution
83+
Feel free extend and contribute to add more functionality.
84+
Personally I'd like to keep it simple as possible, but my Kotlin knowledge not yet good enough.
85+
So if you can improve it or make it more DSL-ish -- please, create PR
86+
87+
* link:./VERSIONS.adoc[versions]
88+
* link:./BINTRAY.adoc[bintray]
89+
* link:./JITPACK.adoc[JitPack]
90+
91+
.build
92+
----
93+
# maven:
94+
./mvnw
95+
96+
# or gradle:
97+
./gradlew
98+
----
99+
100+
generated by link:https://github.com/daggerok/generator-jvm/[jvm] yeoman generator
101+
//end::content[]

VERSIONS.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ see link:./BINTRAY.adoc[bintray] and link:./JITPACK.adoc[jitpack] READMEs to pic
55
|===
66
|bintray jcenter/daggerok|jitpack
77

8+
|0.1.PLUS
9+
|
10+
811
|0.2.PLUS
912
|0.2.PLUS
1013

0 commit comments

Comments
 (0)