-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
35 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |