Skip to content

Commit

Permalink
feat(docs): begin readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SpikeHD committed Sep 26, 2023
1 parent 57ab27b commit 5270b08
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
# Procchi
Process monitoring, acessible from the web
<div align=center>
<h1>Procchi</h1>
<p>Resource monitoring, accessible from the web.</p>
<a href="https://www.discord.gg/agQ9mRdHMZ">https://discord.gg/agQ9mRdHMZ</a>
</div>

<div align="center">
<img src="https://img.shields.io/github/actions/workflow/status/SpikeHD/procchi/build.yml" />
<img src="https://img.shields.io/github/package-json/v/SpikeHD/procchi" />
<img src="https://img.shields.io/github/repo-size/SpikeHD/procchi" />
</div>
<div align="center">
<img src="https://img.shields.io/github/commit-activity/m/SpikeHD/procchi" />
<img src="https://img.shields.io/github/release-date/SpikeHD/procchi" />
<img src="https://img.shields.io/github/stars/SpikeHD/procchi" />
</div>

# Table of Contents

* [Installation](#installation)
* [Usage](#usage)
* [Development](#development)
* [Contributing](#contributing)

# Installation

1. Download a release binary from the [releases page](https://github.com/SpikeHD/procchi/releases), and put it somewhere.
2. That's it!

# Usage

Run the binary via terminal to view a full list of options:

```sh
./procchi -h
```

## Examples


Binary file modified backend/.DS_Store
Binary file not shown.

0 comments on commit 5270b08

Please sign in to comment.