Skip to content

Commit

Permalink
doc: Add some fun emojis
Browse files Browse the repository at this point in the history
  • Loading branch information
macalbert committed Oct 1, 2024
1 parent 2dd0d99 commit 8a18e29
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# Envilder
# 🌱 Envilder

**Envilder** is a CLI tool designed to generate `.env` files from AWS SSM parameters. This is useful for managing environment variables securely in your projects without exposing sensitive information in your codebase.

## Features
## Features

- Fetch parameters securely from AWS SSM Parameter Store.
- Automatically generates a `.env` file with specified parameters.
- Handles both encrypted and unencrypted SSM parameters.
- Lightweight and simple to use.
- 🔒 Fetch parameters securely from AWS SSM Parameter Store.
- Automatically generates a `.env` file with specified parameters.
- 🛡️ Handles both encrypted and unencrypted SSM parameters.
- 🪶 Lightweight and simple to use.

## Installation
## 📦 Installation

You can install **envilder** globally or locally using npm:

```bash
npm install -g envilder
```

## Usage
## 🚀 Usage

Envilder requires two arguments:

- `--map <path>`: Path to a JSON file mapping environment variable names to SSM parameters.
- `--envfile <path>`: Path where the generated .env file will be saved.

## Example
## 🔧 Example

1. Create a mapping file `param_map.json`:

Expand All @@ -38,32 +38,30 @@ Envilder requires two arguments:
2. Run envilder to generate your `.env` file:

```bash
envilder --map=path/to/param_map.json --envfile=.env
envilder --map=param_map.json --envfile=.env
```

3. The `.env` file will be generated in the specified location.

## Sample `.env` Output:
## 📂 Sample `.env` Output

```makefile
[email protected]
NEXT_PUBLIC_CREDENTIAL_PASSWORD=mockedPassword
```

## Running Tests
## 🧪 Running Tests

To run the tests with coverage:

```bash
yarn test
```

## License
## 📝 License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

## Contributing
## 🙌 Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

Created by [Marçal Albert](https://github.com/macalbert).

0 comments on commit 8a18e29

Please sign in to comment.