Skip to content

Commit a32e4be

Browse files
committed
added readme content
1 parent a9f8f72 commit a32e4be

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
# kscript-support-api
2-
A support API written in Kotlin to simplify scripting with kscript
1+
Support API for `kscript`
2+
=========================
3+
4+
5+
[![Build Status](https://travis-ci.org/holgerbrandl/kscript-support-api.svg?branch=master)](https://travis-ci.org/holgerbrandl/kscript-support-api)
6+
7+
8+
[ ![Download](https://api.bintray.com/packages/holgerbrandl/kscript-support-api/images/download.svg) ]
9+
10+
11+
A support API written in Kotlin to simplify scripting with `[kscript](https://github.com/holgerbrandl/kscript)`
12+
13+
14+
For documentation see [kscript](https://github.com/holgerbrandl/kscript#support-api)
15+
16+
17+
Support
18+
-------
19+
20+
21+
Feel welcome to report issues or suggestions [here](https://github.com/holgerbrandl/kscript/issues)
22+
23+
24+
Installation
25+
------------
26+
27+
To get started simply add it as a dependency via Jcenter:
28+
```
29+
compile "de.mpicbg.scicomp:krangl:0.4"
30+
```
31+
32+
33+
License
34+
-------
35+
36+
[MIT](LICENSE)
37+
38+
39+
Developer Info
40+
--------------
41+
42+
43+
```bash
44+
## to install to local maven repo
45+
gradle install
46+
47+
## to run the tests
48+
gradle test
49+
50+
```

0 commit comments

Comments
 (0)