Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hexagon committed Apr 1, 2024
1 parent 60fe2d6 commit dfb3f38
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# @cross/service

Service is a JavaScript/TypeScript module for managing system services. It offers a convenient way to install, uninstall, and generate service configurations for various service managers. It can be
used as either a command line tool, or a typescript library for direct integration in other programs.
used as either a command line tool, or a typescript library for direct integration in other Node/Deno/Bun programs.

Part of the @cross suite - check out our growing collection of cross-runtime tools at [github.com/cross-org](https://github.com/cross-org).

Expand All @@ -12,6 +12,7 @@ Part of the @cross suite - check out our growing collection of cross-runtime too
- Install, uninstall, and generate service configurations
- Compatible with systemd, sysvinit, docker-init, upstart (Linux), launchd (macOS) and SCM (Windows) service managers
- Installs any script as service on any system.
- Cross-Runtime and Cross-Platform.

## Installation

Expand Down Expand Up @@ -68,6 +69,8 @@ Note:

To use the service library programmatically, you can import and use the `installService`, `generateConfig` and `uninstallService` functions.

Install for your runtime according to the instructions at [https://jsr.io/@cross/service].

### InstallServiceOptions

This is the interface for the options used by the `installService` function:
Expand Down

0 comments on commit dfb3f38

Please sign in to comment.