Skip to content

Commit

Permalink
add docs to service
Browse files Browse the repository at this point in the history
Signed-off-by: simonsan <[email protected]>
  • Loading branch information
simonsan committed Mar 29, 2024
1 parent 3383d2b commit 52c8c54
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 0 deletions.
10 changes: 10 additions & 0 deletions crates/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ You can ask questions in the
| Discord | [![Discord](https://dcbadge.vercel.app/api/server/RKSWrAcYdG?style=flat-square)](https://discord.gg/RKSWrAcYdG) |
| Discussions | [GitHub Discussions](https://github.com/orgs/pace-rs/discussions) |

## Crate features

This crate exposes a few features for controlling dependency usage:

- **clap** - Enables a dependency on the `clap` crate and enables parsing from
the commandline. *This feature is enabled by default*.

- **cli** - Enables support for CLI features by enabling `merge` and `clap`
features. *This feature is enabled by default*.

## Examples

TODO!
Expand Down
89 changes: 89 additions & 0 deletions crates/service/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<p align="center">
<img src="https://raw.githubusercontent.com/pace-rs/assets/main/logos/readme_header_service.png" style="max-width:500px; width:100%; height: auto" />
</p>
<p align="center"><b>pace-service - a service library for the pace ecosystem</b></p>

<p align="center">
<a href="https://crates.io/crates/pace_service"><img src="https://img.shields.io/crates/v/pace_service.svg" /></a>
<a href="https://docs.rs/pace_service/"><img src="https://img.shields.io/docsrs/pace_service?style=flat&amp;labelColor=1c1d42&amp;color=4f396a&amp;logo=Rust&amp;logoColor=white" /></a>
<a href="https://raw.githubusercontent.com/pace-rs/pace/main/crates/time/LICENSE"><img src="https://img.shields.io/badge/license-AGPLv3+-red.svg" /></a>
<a href="https://crates.io/crates/pace_service"><img src="https://img.shields.io/crates/d/pace_service.svg" /></a>
<p>

## About

`pace-service` is a library to support timetracking on the command line. It is
the service library for the `pace` timetracking application.

⚠️ **Note:** `pace-service` is currently in active development and is not yet
ready for production use. Expect breaking changes and incomplete features. We
encourage you to try it out and provide feedback, but please be aware that it is
not yet stable.

## Contact

You can ask questions in the
[Discussions](https://github.com/orgs/pace-rs/discussions) or have a look at the
[FAQ](https://pace.cli.rs/docs/FAQ.html).

| Contact | Where? |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| Issue Tracker | [GitHub Issues](https://github.com/pace-rs/pace/issues/new/choose) |
| Discord | [![Discord](https://dcbadge.vercel.app/api/server/RKSWrAcYdG?style=flat-square)](https://discord.gg/RKSWrAcYdG) |
| Discussions | [GitHub Discussions](https://github.com/orgs/pace-rs/discussions) |

<!-- ## Crate features
This crate exposes a few features for controlling dependency usage:
- **clap** - Enables a dependency on the `clap` crate and enables parsing from
the commandline. *This feature is enabled by default*.
- **cli** - Enables support for CLI features by enabling `merge` and `clap`
features. *This feature is enabled by default*.
- **db** - Enables support for database features by enabling `rusqlite`
features. *This feature is enabled by default*.
- **rusqlite** - Enables a dependency on the `rusqlite` crate and enables
database support. *This feature is enabled by default*. -->

## Examples

TODO!

## Contributing

Found a bug? [Open an issue!](https://github.com/pace-rs/pace/issues/new/choose)

Got an idea for an improvement? Don't keep it to yourself!

- [Contribute fixes](https://github.com/pace-rs/pace/contribute) or new features
via a pull requests!

Please make sure, that you read the
[contribution guide](https://pace.cli.rs/docs/contributing_to_pace.html).

## Code of Conduct

Please review and abide by the general
[Rust Community Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct)
when contributing to this project. In the future, we might create our own Code
of Conduct and supplement it at this location.

## Minimum Rust version policy

This crate's minimum supported `rustc` version is `1.74.1`.

The current policy is that the minimum Rust version required to use this crate
can be increased in minor version updates. For example, if `crate 1.0` requires
Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
version of Rust.

In general, this crate will be conservative with respect to the minimum
supported version of Rust.

## License

**AGPL-3.0-or-later**; see [LICENSE](./LICENSE).

0 comments on commit 52c8c54

Please sign in to comment.