Skip to content

Commit 108ef04

Browse files
docs: Add README, LICENSE and CONTRIBUTING md
1 parent 0a1bc8a commit 108ef04

File tree

3 files changed

+77
-0
lines changed

3 files changed

+77
-0
lines changed

CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contributing to Cipher Collection
2+
3+
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
4+
2. Install the dependencies: `npm install`.
5+
3. Edit a current cipher or add a new cipher file in the `src` folder.
6+
4. Add tests into `test/` directory and try them with `npm test`.
7+
5. Make the PR!

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Alexander Lichter ([@manniL](https://github.com/manniL))
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Cipher Collection - All crypto algorithms you need
2+
3+
> Zero-dependency modular cipher collection including all well-known and often used ciphers.
4+
5+
## Features
6+
7+
- Modules per cipher to reduce size
8+
- Available as UMD, CJS and ES Module
9+
- Well tested and [documented](./docs/index.md)
10+
- Zero dependencies
11+
- Customizable error handling
12+
13+
## Getting started
14+
15+
16+
### Through NPM
17+
```
18+
$ npm install cipher-collection
19+
```
20+
21+
ES6 import:
22+
23+
```
24+
import { rot } from 'cipher-collection'
25+
26+
console.log(rot('Hello world!'))
27+
```
28+
ES5 import:
29+
30+
```
31+
const rot = require('cipher-collection/rot')
32+
33+
console.log(rot('Hello world!'))
34+
```
35+
36+
37+
## Currently available ciphers
38+
39+
- ROT-N (custom number of rotations, optional number rotation)
40+
41+
42+
## Contributing
43+
44+
Please see our [CONTRIBUTING.md](./CONTRIBUTING.md)
45+
46+
47+
## 📑 License
48+
49+
[MIT License](./LICENSE) - Copyright (c) Developmint - Alexander Lichter

0 commit comments

Comments
 (0)