Skip to content

Commit

Permalink
Split up READMEs properly
Browse files Browse the repository at this point in the history
  • Loading branch information
fwcd committed Mar 16, 2024
1 parent 6c824fe commit b8641cf
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Project Lighthouse SDK for Rust

[![crates.io](https://img.shields.io/crates/v/lighthouse-client)](https://crates.io/crates/lighthouse-client)
[![Build](https://github.com/ProjectLighthouseCAU/lighthouse-rust/actions/workflows/build.yml/badge.svg)](https://github.com/ProjectLighthouseCAU/lighthouse-rust/actions/workflows/build.yml)

An asynchronous library for interacting with Project Lighthouse in Rust, e.g. to build games or other clients. The library is defined in terms of `futures` and can thus be used with any async runtime, though additional convenience functions are provided for `async-std` and `tokio`. The latter can be enabled via the corresponding crate features.
Crates for interacting with Project Lighthouse in Rust, e.g. to build games or other clients.

| Crate | Version | Docs |
| - | - | - |
| [lighthouse-client](./lighthouse-client) | [![crates.io](https://img.shields.io/crates/v/lighthouse-client)](https://crates.io/crates/lighthouse-client) | [![docs.rs](https://img.shields.io/docsrs/lighthouse-client)](https://docs.rs/lighthouse-client) |
| [lighthouse-protocol](./lighthouse-protocol) | [![crates.io](https://img.shields.io/crates/v/lighthouse-protocol)](https://crates.io/crates/lighthouse-protocol) | [![docs.rs](https://img.shields.io/docsrs/lighthouse-protocol)](https://docs.rs/lighthouse-protocol) |

## Example Usage

Expand Down
26 changes: 26 additions & 0 deletions lighthouse-client/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# Lighthouse Client

[![crates.io](https://img.shields.io/crates/v/lighthouse-client)](https://crates.io/crates/lighthouse-client)
[![docs.rs](https://img.shields.io/docsrs/lighthouse-client)](https://docs.rs/lighthouse-client)

An asynchronous library for building clients for Project Lighthouse, e.g. games or animations.

The library is defined in terms of `futures` and can thus be used with any async runtime, though additional convenience functions are provided for `async-std` and `tokio`. The latter can be enabled via the corresponding crate features.

## Example Usage

First make sure to have a login at [lighthouse.uni-kiel.de](https://lighthouse.uni-kiel.de) and to have your credentials defined as environment variables:

```bash
export LIGHTHOUSE_USER=[your username]
export LIGHTHOUSE_TOKEN=[your api token]
```

You can now run an example with

```bash
cargo run --example disco
```

For a more complex example, try

```bash
cargo run --example snake
```
3 changes: 3 additions & 0 deletions lighthouse-protocol/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Lighthouse Protocol

[![crates.io](https://img.shields.io/crates/v/lighthouse-protocol)](https://crates.io/crates/lighthouse-protocol)
[![docs.rs](https://img.shields.io/docsrs/lighthouse-protocol)](https://docs.rs/lighthouse-protocol)

Protocol types for interacting with Project Lighthouse's model server.

0 comments on commit b8641cf

Please sign in to comment.