Skip to content

Commit a984a09

Browse files
committed
πŸŽ‰ Final version release 🎈
Still yet to bring folder encryption & decryption back
1 parent f4fd218 commit a984a09

File tree

2 files changed

+49
-3
lines changed

2 files changed

+49
-3
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# node-filecrypt
2+
πŸ” Encrypt files with RSA Key-Pair Encryption πŸ“‚
3+
4+
**This project is not actively maintained**
5+
6+
## Getting Started
7+
Instructions below will get your copy of this project up and running on your local machine for deployment and development purposes.
8+
9+
### Prerequisites
10+
Project requirements
11+
12+
```
13+
NodeJS - Version v8.12.0 and above
14+
NPM - Version 6.4.1 and above
15+
```
16+
17+
### Installing
18+
19+
```
20+
- NodeJS: https://nodejs.org/en/
21+
- NPM: Comes preinstalled with NodeJS
22+
```
23+
24+
## Deployment
25+
26+
Steps:
27+
1. Run `git clone https://github.com/Etosticity/node-filecrypt`
28+
2. Inside the Git Cloned directory, run `npm install`
29+
3. Run `node main.js`
30+
31+
## Built With
32+
* [Git](https://git-scm.com/)
33+
* [JavaScript](https://www.javascript.com/)
34+
* [Visual Studio Code](https://code.visualstudio.com/)
35+
36+
## Versioning
37+
We use [Semantic Versioning](https://semver.org/). For the versions available in this project, see the [tags in this repository](https://github.com/Etosticity/node-filecrypt/tags).
38+
39+
## Authors
40+
* **Etosticity Rammington** - *Project Owner*
41+
42+
Also, see the list of [contributors](https://github.com/Etosticity/node-filecrypt/graphs/contributors) who participated in this project.
43+
44+
## License
45+
This project is licensed under GPL-3.0 License. See [LICENSE](https://github.com/Etosticity/node-filecrypt/blob/master/LICENSE)

β€Žpackage.jsonβ€Ž

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
{
22
"name": "filecrypt",
3-
"version": "v0.4.1-beta",
3+
"version": "v0.4.2-beta",
44
"description": "Encrypt files using RSA Encryption",
55
"main": "main.js",
66
"scripts": {
7-
"clean": "rm -rf ./.rsakeys *.enc",
8-
"update": "npm update"
7+
"update": "npm update",
8+
"start": "node main.js",
9+
"clean": "rm -rf ./.rsakeys *.enc"
910
},
1011
"repository": {
1112
"type": "git",

0 commit comments

Comments
Β (0)