-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
699fdb5
commit e403b25
Showing
2 changed files
with
106 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 Watchdog0x | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
# chunkHide | ||
![Static Badge](https://img.shields.io/badge/Version-1.0.0-brightgreen?style=for-the-badge&color=rgb(93%2C%2063%2C%20211)) | ||
|
||
|
||
`chunkHide` is a command-line utility for modifying PNG image files by manipulating chunks. | ||
It allows you to add, modify, or read text chunks in a PNG image. | ||
|
||
## Table of Contents | ||
- [Options](#options) | ||
- [Installation](#installation) | ||
- [Examples](#examples) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
## Options | ||
- **-i [image.png]:** Path to the PNG image file. | ||
- **-t [tEXt]:** Specify chunk types: | ||
- tEXt: Text chunk | ||
- zTXt: Compressed text chunk | ||
- PLTE: Palette chunk | ||
- **-o [output.png]:** Where to output the modified image. Default: output.png | ||
- **-v [image.png]:** Validate the image chunks. Example: chunkHide -v image.png | ||
- **-r:** Read the chunk data. Requires the -t option. Example: chunkHide -r -t tEXt | ||
- **-keyword:** Keyword for the chunk. Required with -t tEXt or -t zTXt. | ||
- **-text:** Text for the chunk. Required with -t tEXt, -t zTXt, or -t PLTE. | ||
|
||
## Installation | ||
|
||
To use `chunkHide` in your Go projects or as a command-line tool, follow these installation steps: | ||
|
||
### Downloading the Latest Release | ||
|
||
Visit the [Latest Releases](https://github.com/Watchdog0x/chunkHide/releases) page on the GitHub repository to download the binary executable for your operating system. Pre-built binaries for common platforms, such as Linux, macOS, and Windows, are available. | ||
|
||
### Manual Installation | ||
|
||
Alternatively, install `chunkHide` manually by cloning the GitHub repository and building the binary using Go: | ||
|
||
```bash | ||
git clone https://github.com/Watchdog0x/chunkHide.git | ||
cd chunkHide | ||
go build -o chunkHide cmd/main.go | ||
``` | ||
|
||
### Installing as a Go Module | ||
|
||
If you want to integrate chunkHide as a dependency in your Go project, you can add it as a module: | ||
|
||
```bash | ||
go get github.com/Watchdog0x/chunkHide | ||
``` | ||
|
||
Import it in your Go code: | ||
|
||
```go | ||
import "github.com/Watchdog0x/chunkHide" | ||
``` | ||
|
||
Then, you can use chunkHide as a module in your project. | ||
|
||
|
||
## Examples | ||
|
||
```bash | ||
# Add a text chunk to the image | ||
chunkHide -t tEXt -keyword mykey -text Hello -i input.png -o output.png | ||
|
||
# Add a compressed text chunk to the image | ||
chunkHide -t zTXt -keyword mykey -text Hello -i input.png -o output.png | ||
|
||
# Read text data from the image | ||
chunkHide -r -t tEXt -i input.png | ||
|
||
# Validate image chunks | ||
chunkHide -v input.png | ||
``` | ||
|
||
|
||
## Contributing | ||
Contributions are welcome! Feel free to open issues, submit pull requests, or provide suggestions. Please follow the Contributing Guidelines. | ||
|
||
## License | ||
This project is licensed under the MIT License | ||
|
||
|