Skip to content

Commit

Permalink
Update README.md (#92)
Browse files Browse the repository at this point in the history
Thanks for feedback everyone
  • Loading branch information
ksmotiv8 authored Apr 5, 2022
1 parent 2303a17 commit bf5977d
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# Momento CLI

_Read this in other languages_: [日本語](README.ja.md)
<br >
Japanese: [日本語](README.ja.md)

## Prerequisites

- MacOS or Linux
- [Homebrew](https://brew.sh/)

## Install



## Quick Start
```
# Install
brew tap momentohq/tap
brew install momento-cli
# Sign Up [available regions are us-west-2, us-east-1, ap-northeast-1, default is us-west-2]
momento account signup --email <TYPE_YOUR_EMAIL_HERE> --region <TYPE_DESIRED_REGION>
# Make a cache
momento cache create --name example-cache
# Set and Get values from your cache
momento cache set --key key --value value --ttl 100 --name example-cache
momento cache get --key key --name example-cache
```

## Upgrading
Expand All @@ -21,7 +31,8 @@ brew update momento-cli
brew upgrade momento-cli
```

## Sign up
## Sign up


**NOTE:** If you run into errors during signup, please ensure you have upgraded to the [latest version](https://github.com/momentohq/momento-cli/releases/latest) of our CLI.

Expand All @@ -32,6 +43,10 @@ momento account signup --email <TYPE_YOUR_EMAIL_HERE>
# (optional) view help to see all available regions, and sign up for a specific region
momento account signup --help
momento account signup --email <TYPE_YOUR_EMAIL_HERE> --region <TYPE_DESIRED_REGION>
# Configure CLI
momento configure
```

Upon signing up, Momento sends a token to the email provided. This token uniquely identifies cache interactions. The token should be treated like a sensitive password and all essential care must be taken to ensure its secrecy. We recommend that you store this token in a secret vault like AWS Secrets Manager.
Expand Down

0 comments on commit bf5977d

Please sign in to comment.