Skip to content

Commit

Permalink
docs: reformat README (#11)
Browse files Browse the repository at this point in the history
* Reformat README

* quick fix

* add a few more links
  • Loading branch information
danielamiao authored Nov 9, 2021
1 parent db5ca38 commit 345d6e0
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
Momento Client CLI
## Prerequisites
- MacOS or Linux
- [Homebrew](https://brew.sh/)

## Prerequisite
1. [Homebrew](https://brew.sh/)
## Install
```bash
brew tap momentohq/tap
brew install momento-cli
```

## Installation
1. brew tap momentohq/tap
1. brew install momento-cli
## Configure
```
momento configure
```
This will prompt you for your Momento Auth Token, and save it to be reused. Need a token? Send us an email at [email protected].

## Instructions
1. after installation, run the command `momento configure`. This will prompt you for
your momento auth token, and save it to be reused.
## Use CLI
```
momento cache create --name example-cache
momento cache set --key key --value value --ttl 100 --name example-cache
momento cache get --key key --name example-cache
```

## Using Momento Cache
1. momento cache create --name example-cache
1. momento cache set --key key --value value --ttl 100 --name example-cache
1. momento cache get --key key --name example-cache
1. momento cache delete --name example-cache
## Use Momento in Your Project
Check out our [SDKs](https://github.com/momentohq/client-sdk-examples) to integrate Momento into your project!

0 comments on commit 345d6e0

Please sign in to comment.