diff --git a/README.md b/README.md index 19160500..c5c8db3a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,28 @@ # Momento CLI -_Read this in other languages_: [日本語](README.ja.md) -
+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 --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 @@ -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. @@ -32,6 +43,10 @@ momento account signup --email # (optional) view help to see all available regions, and sign up for a specific region momento account signup --help momento account signup --email --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.