Skip to content

Commit

Permalink
Update README.md to include installation instructions and format cons…
Browse files Browse the repository at this point in the history
…ole commands
  • Loading branch information
jonnylink committed Dec 9, 2024
1 parent 4513a96 commit 2cb00e2
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,28 @@

This is just a tiny and basic helper package to work with Secrets in AWS.

## Install
Download the package or use composer:
```composer require jonlink/laravel-aws-secrets```

## Usage
To use this you will need to have AWS credentials. Typically a secret would be created manually and then rotated via a Laravel schedule.


### Create a secret
Secrets can created from the AwsSecrets class programmatically, or through the console command:
`aws-secret:create {your-secret-name} {optional-secret-value}`

```aws-secret:create {your-secret-name} {optional-secret-value}```

### Get a secret
Secrets can retrieved from the AwsSecrets class programmatically, or through the console command:
`aws-secret:get {your-secret-name}`

```aws-secret:get {your-secret-name}```

### Rotate a secret
Secrets can be rotated via a console command:
`aws-secret:rotate {your-secret-name} {optional-secret-value}`

In all cases if you do not choose a secret value, one will be generated automatically.
```aws-secret:rotate {your-secret-name} {optional-secret-value}```

### notes:
* In all cases if you do not choose a secret value, one will be generated automatically.

0 comments on commit 2cb00e2

Please sign in to comment.