Skip to content

Commit

Permalink
README update install and run instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jtmoon79 committed Sep 17, 2022
1 parent 03b216e commit 01f3959
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

Speedily search and sort many syslog files by datetime.

_Super Speedy Syslog Searcher_ (s4) can search within compressed syslog files
(`.gz`, `.xz`) and syslog archives (`.tar`, `.zip`).
_Super Speedy Syslog Searcher_ (s4) is a command-line tool to search
and sort syslog files within compressed files (`.gz`, `.xz`) and
archives (`.tar`, `.zip`).
The first goal of s4 is speedy searching and printing.

[![Build status](https://github.com/jtmoon79/super-speedy-syslog-searcher/actions/workflows/rust.yml/badge.svg)](https://github.com/jtmoon79/super-speedy-syslog-searcher/actions?query=workflow%3Arust)
Expand All @@ -16,8 +17,8 @@ The first goal of s4 is speedy searching and printing.
<!-- TOC generated by Markdown All In One -->

- [Use](#use)
- [Install](#install)
- [Run](#run)
- [Install `super_speedy_syslog_searcher`](#install-super_speedy_syslog_searcher)
- [Run `s4`](#run-s4)
- [`--help`](#--help)
- [About](#about)
- [Features](#features)
Expand All @@ -29,13 +30,13 @@ The first goal of s4 is speedy searching and printing.

## Use

### Install
### Install `super_speedy_syslog_searcher`

```text
cargo install s4
cargo install super_speedy_syslog_searcher
```

### Run
### Run `s4`

For example, print all the messages under `/var/log/`.

Expand Down

0 comments on commit 01f3959

Please sign in to comment.