Skip to content

Commit

Permalink
Add 'Documentation' and 'Support' section in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Francesco Vasco committed Oct 1, 2024
1 parent 60eceaf commit 11e5ad8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/workflows/static.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name: Docs
on:
push:
branches: [ main ]

permissions:
contents: write

Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ Supported features:
- Client messages
- TLCP-diff compression

For questions and support please use the [Official Forum](https://forums.lightstreamer.com/).
The issue list of this page is **exclusively** for bug reports and feature requests.

## Installation

Lightstreamer Kotlin SDK requires JVM version 21 or later.
Expand All @@ -43,7 +40,7 @@ dependencies {
## Quickstart

To open a session to a Lightstreamer Server, you need to configure a [LightstreamerClient](./kotlin/com/lightstreamer/client/LightstreamerClient.kt).
A minimal version of the code that creates a LightstreamerClient and connects to the Lightstreamer Server on *https://push.lightstreamer.com* will look like this:
A minimal version of the code that creates a LightstreamerClient, connects to the Lightstreamer Server and subscribes an item, will look like this:

```kotlin
import com.lightstreamer.client.LightstreamerClient
Expand Down Expand Up @@ -113,3 +110,12 @@ then build and test using gradle:
```sh
gradle build
```

## Documentation

- [API reference](https://lightstreamer.github.io/Lightstreamer-lib-client-mini-kotlin/)

## Support

For questions and support please use the [Official Forum](https://forums.lightstreamer.com/).
The issue list of this page is **exclusively** for bug reports and feature requests.

0 comments on commit 11e5ad8

Please sign in to comment.