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

chore(doc): update README #21

Merged
merged 1 commit into from
Dec 7, 2024
Merged

chore(doc): update README #21

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
8 changes: 4 additions & 4 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ jobs:
- name: Test
run: go build -v && go test ./...
- name: Build for linux/amd64
run: go build -o discache-all-linux-amd64
run: go build -o discache-linux-amd64
- name: Build for linux/arm64
run: GOOS=linux GOARCH=arm64 go build -o discache-all-linux-arm64
run: GOOS=linux GOARCH=arm64 go build -o discache-linux-arm64
- name: Build for mac
run: GOOS=darwin go build -o discache-all-darwin-amd64
run: GOOS=darwin go build -o discache-darwin-amd64
- name: Build for mac Apple Silicon
run: GOOS=darwin GOARCH=arm64 go build -o discache-all-darwin-arm64
run: GOOS=darwin GOARCH=arm64 go build -o discache-darwin-arm64

- uses: "marvinpinto/action-automatic-releases@latest"
with:
Expand Down
35 changes: 25 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,37 @@
Discache is a powerful, but simple memory cache in Golang. Using TCP and binary as a transporter makes it very performant.

# Table of Contents
- [Installation](#installation)
- [Cli](#cli)
- [Client](#client)

### Installation

#### Discache

**From releases**
This installs binary.

* Linux
```
curl -LO "https://github.com/dhyanio/discache/releases/download/$(curl -s https://api.github.com/repos/dhyanio/discache/releases/latest | grep tag_name | cut -d '"' -f 4)/discache-linux-amd64"
chmod +x discache-linux-amd64
sudo mv discache-linux-amd64 /usr/local/bin/discache
```
* MacOS
```
curl -LO "https://github.com/dhyanio/discache/releases/download/$(curl -s https://api.github.com/repos/dhyanio/discache/releases/latest | grep tag_name | cut -d '"' -f 4)/discache-darwin-amd64"
chmod +x discache-darwin-amd64
sudo mv discache-darwin-amd64 /usr/local/bin/discache
```

**From source**
1. Run `git clone <discache repo> && cd discache/`
2. Run `make build`

## CLI
A CLI tool has commands

### Requirements
- Go (version 1.17 or later)

### Makefile Targets
#### Variables
- `LISTEN_ADDR` - Address for the server to listen on (default: `:4000`).
Expand All @@ -26,13 +48,6 @@ A CLI tool has commands
These can be passed as arguments when running specific commands.

### 📚 Usage
- Build the Project

```bash
make build
```
Builds the Go binary and places it in the bin/ directory.

- Run the Project

```bash
Expand Down
Loading