Skip to content

Commit 0856bf9

Browse files
authored
Improve documentation (#6)
- Added short description of features - Added travis, coverall and maven badges * Fix links.
1 parent adfb03f commit 0856bf9

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

.travis.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ matrix:
2929
script:
3030
- travis_wait 30 ./scripts/ci.sh
3131

32+
after_success:
33+
- ./sbtx coveralls
34+
3235
cache:
3336
directories:
3437
- "$HOME/.sbt/1.0"

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
11
# Import Export UDF Common Scala
22

3-
Common libraries for Exasol IMPORT and EXPORT user-defined functions in Scala
3+
[![Build Status][travis-badge]][travis-link]
4+
[![Coveralls][coveralls-badge]][coveralls-link]
5+
[![Maven Central][maven-badge]][maven-link]
6+
7+
Common libraries for Exasol IMPORT and EXPORT user defined functions in Scala
48
programming language.
59

10+
## Features
11+
12+
- Supports user provided key value parameters parsing
13+
- Supports Avro record deserialization into internal data structure
14+
15+
## Information for Users
16+
17+
- [Changelog](doc/changes/changelog.md)
18+
619
## Dependencies
720

821
### Runtime Dependencies
@@ -43,6 +56,12 @@ These plugins help with project development.
4356
| [SBT PGP][sbt-pgp-link] | PGP plugin for `sbt` | BSD 3-Clause License |
4457
| [SBT Git][sbt-git-link] | A plugin for Git integration, used to version the release jars | BSD 2-Clause License |
4558

59+
[travis-badge]: https://img.shields.io/travis/exasol/import-export-udf-common-scala/master.svg?logo=travis
60+
[travis-link]: https://travis-ci.com/exasol/import-export-udf-common-scala
61+
[coveralls-badge]: https://coveralls.io/repos/github/exasol/import-export-udf-common-scala/badge.svg?branch=master
62+
[coveralls-link]: https://coveralls.io/github/exasol/import-export-udf-common-scala?branch=master
63+
[maven-badge]: https://maven-badges.herokuapp.com/maven-central/com.exasol/import-export-udf-common-scala_2.12/badge.svg
64+
[maven-link]: https://mvnrepository.com/artifact/com.exasol/import-export-udf-common-scala
4665
[apache-avro-link]: https://avro.apache.org/
4766
[scala-logging-link]: https://github.com/lightbend/scala-logging
4867
[exasol-script-api-link]: https://docs.exasol.com/database_concepts/udf_scripts.htm

doc/changes/changes_0.1.0.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
# Import Export UDF Common Scala v0.1.0, released 2020-MM-DD
1+
# Import Export UDF Common Scala 0.1.0, released 2020-MM-DD
2+
3+
## Features
4+
5+
* [#1](https://github.com/exasol/import-export-udf-common-scala/issues/1): Added initial implementation (PR [#2](https://github.com/exasol/import-export-udf-common-scala/pull/2))
6+
* [#3](https://github.com/exasol/import-export-udf-common-scala/issues/3): Updated documentation (PR [#4](https://github.com/exasol/import-export-udf-common-scala/pull/6))

0 commit comments

Comments
 (0)