# learn-crypto

> Project for learning cryptography.

Latest version **0.0.8** (published 2018-03-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install learn-crypto
pnpm add learn-crypto
yarn add learn-crypto
bun add learn-crypto
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2018-03-25 |
| First published | 2018-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Eric Ren |
| Maintainers | rencire |

## Links

- npm: https://www.npmjs.com/package/learn-crypto
- Repository: https://github.com/rencire/learn-crypto
- Issues: https://github.com/rencire/learn-crypto/issues
- npm.io page: https://npm.io/package/learn-crypto

## Dependencies (1)

- [core-js](https://npm.io/package/core-js.md) ^2.5.3

## Recent versions

- 0.0.8 (latest) — 2018-03-25
- 0.0.7 — 2018-03-25
- 0.0.1 — 2018-03-24

## README

# Learn Crypto

Personal project to (re)learn common cryptography.

Please don't use this for serious production apps! As the saying goes, [Don't roll your own](https://security.stackexchange.com/questions/18197/why-shouldnt-we-roll-our-own)

// NOTE: Code needs to be run in an environment with `String.fromCodePoint`.
// Might need to polyfill if environment is missing the function (e.g, IE11)
// import "core-js/fn/string/from-code-point";

## TODO

* [ ] publish package to npm

## Quick start

```
npm install learn-crypto
import { createCipher } from 'learn-crypto'

const cipher = createCipher();

const key = "super_secret_key"
const msg = "super_secret_message"
const ciphertext = cipher.encrypt(msg, key)
// "æÊÆäÊè¾ØÊìæÆÊ×"
const msg = cipher.decrypt(ciphertext, key)
// "super_secret_message"
```

---
_Source: https://npm.io/package/learn-crypto · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._