Prepare for publishing
This commit is contained in:
22
README.md
22
README.md
@@ -1,7 +1,10 @@
|
||||
# SimConnect SDK in Rust
|
||||
|
||||
[![Crates][crates_badge]][crates]
|
||||
[![Documentation][documentation_badge]][documentation]
|
||||
[![CI][ci_badge]][ci]
|
||||
|
||||
[![license][license_badge]][license]
|
||||
[![Crates.io][crates_downloads_badge]][crates]\
|
||||
An opinionated SimConnect SDK that encapsulates the C API fully and optimizes for developer experience.
|
||||
|
||||
## Usage
|
||||
@@ -83,6 +86,10 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
|
||||
See [more examples][examples].
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome and encouraged! See [/CONTRIBUTING.md][contributing].
|
||||
|
||||
## Feature table
|
||||
|
||||
### General
|
||||
@@ -178,6 +185,19 @@ See [more examples][examples].
|
||||
| SimConnect_CompleteCustomMissionAction | | |
|
||||
| SimConnect_ExecuteMissionAction | | |
|
||||
|
||||
## Credits
|
||||
|
||||
Inspired by [Sequal32/simconnect-rust][inspired_by].
|
||||
|
||||
[crates_badge]: https://img.shields.io/crates/v/simconnect-sdk.svg
|
||||
[crates]: https://crates.io/crates/simconnect-sdk
|
||||
[documentation_badge]: https://docs.rs/simconnect-sdk/badge.svg
|
||||
[documentation]: https://docs.rs/simconnect-sdk
|
||||
[ci_badge]: https://github.com/mihai-dinculescu/simconnect-sdk/workflows/CI/badge.svg?branch=main
|
||||
[ci]: https://github.com/mihai-dinculescu/simconnect-sdk/actions
|
||||
[license_badge]: https://img.shields.io/crates/l/simconnect-sdk.svg
|
||||
[license]: https://github.com/mihai-dinculescu/simconnect-sdk/blob/main/LICENSE
|
||||
[crates_downloads_badge]: https://img.shields.io/crates/d/simconnect-sdk?label=downloads
|
||||
[examples]: https://github.com/mihai-dinculescu/simconnect-sdk/tree/main/examples
|
||||
[contributing]: https://github.com/mihai-dinculescu/simconnect-sdk/blob/main/CONTRIBUTING.md
|
||||
[inspired_by]: https://github.com/Sequal32/simconnect-rust
|
||||
|
Reference in New Issue
Block a user