@stacksjs/security/README.md

The Stacks framework security.

# Stacks Path

Easily work with encryptions, decryptions, and hashing.

## ☘️ Features

- Base64 support
- Bcrypt support
- Argon support
- Implements the Advanced Encryption Standard (AES)
- Written in modern ESM/TypeScript

## 🤖 Usage

```bash
bun install -d @stacksjs/security
```

Now, you can easily access it in your project:

```js
import { base64Encode, base64Verify, bcryptEncode, bcryptVerify, decrypt, encrypt, makeHash, md5Encode, verifyHash } from '@stacksjs/security'

// and more...
```

To view the full documentation, please visit [https://stacksjs.org/security](https://stacksjs.org/security).

## 🧪 Testing

```bash
bun test
```

## 📈 Changelog

Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.

## 🚜 Contributing

Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.

## 🏝 Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)

For casual chit-chat with others using this package:

[Join the Stacks Discord Server](https://discord.gg/stacksjs)

## 🙏🏼 Credits

Many thanks to the following core technologies & people who have contributed to this package:

- [crypto-js](https://github.com/brix/crypto-js)
- [js-base64](https://www.npmjs.com/package/js-base64)
- [Chris Breuer](https://github.com/chrisbbreuer)
- [All Contributors](../../contributors)

## 📄 License

The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.

Made with 💙