Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(readme): Add installation details #42

Merged
merged 1 commit into from
Sep 26, 2024
Merged

feat(readme): Add installation details #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ A standalone cli tool used to manage dependencies for services. It simplifies th

`devservices` reads configuration files located in the `devservices` directory of your repository. These configurations define services, their dependencies, and various modes of operation.

## Installation

A system-wide installation can be done by downloading the binary of the latest release

```
PLATFORM=darwin # Options: darwin/linux
INSTALL_DIR="$HOME/.local/bin"
curl -L "https://github.com/getsentry/devservices/releases/download/0.0.3/devservices-$PLATFORM" -o "$INSTALL_DIR/devservices"
chmod +x "$INSTALL_DIR/devservices"
```

Alternatively, if the repository you're working in has a python virtualenv, you can simply add this to the requirements-dev.txt:

```
devservices==0.0.3
```
## Usage

devservices provides several commands to manage your services:
Expand Down
2 changes: 2 additions & 0 deletions scripts/bump-version.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ function replace() {
}

replace "version = \"$OLD_VERSION\"" "version = \"$NEW_VERSION\"" pyproject.toml
replace "devservices==$OLD_VERSION" "devservices==$NEW_VERSION" README.md
replace "devservices\/releases\/download\/$OLD_VERSION\/" "devservices\/releases\/download\/$NEW_VERSION\/" README.md