Skip to content

Commit

Permalink
Mention about manpages and completions in Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jtsagata committed Jun 21, 2024
1 parent 5f4e0eb commit db5f2e1
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
6 changes: 6 additions & 0 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ tag-version: check
git tag -a v{{ version }} -m "Release v{{ version }}"
git push origin v{{ version }}

# Remove a tag
tag-remove: check
git tag --delete v{{ version }}
git push --delete origin v{{ version }}
git push origin main

# crate tag push it to origin and then publish to crates.io (TODO)
crates: tag-version
cargo publish
Expand Down
6 changes: 5 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Crates.io](https://img.shields.io/crates/v/places-cli)](https://crates.io/crates/places-cli)
[![GitHub Release](https://img.shields.io/github/v/release/jtsagata/places-cli?include_prereleases)](https://github.com/jtsagata/places-cli/releases)
[![GitHub Release](https://img.shields.io/github/v/release/jtsagata/places-cli)](https://github.com/jtsagata/places-cli/releases)
[![CI](https://github.com/jtsagata/places-cli/workflows/CI/badge.svg)](https://github.com/jtsagata/places-cli/actions)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

Expand Down Expand Up @@ -67,6 +67,10 @@ cargo install --force places-cli

> --`force` just makes it update to the latest `places-cli` if it's already installed
Download the man page and the completions for github repository and put them in the right place.

Next version will have an installation script and hopefully some deb packages and rpms (help wanted with github actions).


#### Verifiy the installation
To verify if the installation was successful, you can run
Expand Down
3 changes: 1 addition & 2 deletions crates-io-readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# places-cli
A handy tool for your scripts to always get correct path names for known locations.
Sometimes the location is changed by either ENVIRONMENT variables, or by user localization.
A handy tool for your scripts to get correct path names from known locations or XDG directories.

## Quick usage
```text
Expand Down

0 comments on commit db5f2e1

Please sign in to comment.