Skip to content

Commit

Permalink
Re: Re: Rename
Browse files Browse the repository at this point in the history
  • Loading branch information
nishi-kuma committed Jul 8, 2022
1 parent de5cd49 commit df28d20
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# steganography_ts
# ts-steganography

steganography_ts is a TypeScript library used to encode secret messages inside images and to decode them again.
ts-steganography is a TypeScript library used to encode secret messages inside images and to decode them again.
It will be a replacement of steganography.js to TypeScript. The usage itself is the same.

## How does it work

Behind the scenes steganography_ts uses an algorithm to convert the given message into appropriate binary data which then will be hidden in the alpha channel of the given cover image. A HTML5 canvas element is then used to process the data and the image.
Behind the scenes ts-steganography uses an algorithm to convert the given message into appropriate binary data which then will be hidden in the alpha channel of the given cover image. A HTML5 canvas element is then used to process the data and the image.
To decode a message from a given image, a similiar algorithm is applied on the imagedata.

## How to use it

~~The use of the library is very simple. You just have to add the .js-file to your website and by now you can make use of the global object **steganography** or short **steg** and the two provided functions **encode** and **decode**.~~

```shell
$ npm install steganography_ts
$ npm install ts-steganography
```

- **encode** takes a _message_ as String and a _image_ as Image, HTMLImageElement or String representing the data-URL of the cover image. Returns the data-URL of the image with the encoded message inside.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@nishikuma/steganography_ts",
"name": "ts-steganography",
"description": "TypeScript version of steganography.js",
"homepage": "https://github.com/Nishisonic/steganography_ts#readme",
"homepage": "https://github.com/Nishisonic/ts-steganography#readme",
"repository": {
"type": "git",
"url": "https://github.com/Nishisonic/steganography_ts"
"url": "https://github.com/Nishisonic/ts-steganography"
},
"version": "2.0.1",
"license": "MIT",
Expand Down

0 comments on commit df28d20

Please sign in to comment.