Skip to content

Commit 97aa135

Browse files
committed
doc: Add published RubyGem name to README
1 parent 6a859f5 commit 97aa135

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
# CognitoIdp
22

3-
TODO: Delete this and the text below, and describe your gem
4-
5-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cognito_idp/client`. To experiment with that code, run `bin/console` for an interactive prompt.
3+
Client for interacting with Amazon Cognito IdP (User Pools) endpoints.
64

75
## Installation
86

9-
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
10-
117
Install the gem and add to the application's Gemfile by executing:
128

13-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
9+
$ bundle add cognito_idp
1410

1511
If bundler is not being used to manage dependencies, install the gem by executing:
1612

17-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
13+
$ gem install cognito_idp
1814

1915
## Usage
2016

0 commit comments

Comments
 (0)