README
¶
🌟 How it works
This package encrypts and decrypts a file using a password provided.
📦 Installation and Usage
Go
Make sure you have Go installed on your machine.
You can check by running the following command in the console
go version
If you don't have Go installed, you can download it from here.
Add to your project
Run the following command in the console, in the project directory, to install the library with go get
go get github.com/ggoodwin/go-encrypto
Importing
Add the import to your .go file
import encrypto "github.com/ggoodwin/go-encrypto"
💰 Usage
Check if the Market is Open at Current Time
// Encrypt File
// Parameters: key byte[], inputFile string, outputFile string
error := encrypto.encryptFile(key, inputFile, outputFile)
if error != nil {
panic(error)
}
// Decrypt File
// Parameters: key byte[], inputFile string, outputFile string
error := encrypto.decryptFile(key, inputFile, outputFile)
if error != nil {
panic(error)
}
💻 Dependencies
🙇♂️ Issues and Contributing
If you find an issue with this library, please report the issue using our GITHUB-ISSUES or check out the SECURITY details if it is security related.
If you'd like, I welcome any contributions. Please read the CONTRIBUTING document then FORK this library and submit a PULL-REQUEST. Make sure to click compare across forks to see your fork.
⚖️ License
This project is under the MIT License. See the LICENSE file for the full license text.
📜 Changes
Check out our CHANGELOG
👍🏻 Code of Conduct
Please read my CODE-OF-CONDUCT before contributing or engaging in discussions.
Directories