mirrors/CyberChef
1
0
Fork 0
mirror of https://github.com/gchq/CyberChef.git synced 2025-05-07 15:07:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme per suggestion

Browse source
This commit is contained in:
Dave York 2021-07-01 09:32:02 -04:00
parent 0668a9d4cf
commit f3abb05342
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -22,17 +22,6 @@ Cryptographic operations in CyberChef should not be relied upon to provide secur
[A live demo can be found here][1] - have fun!
## Running in Docker
If you would like to run the app locally in docker please follow the steps below:
```
git clone https://github.com/gchq/CyberChef.git
cd CyberChef
docker build --tag cyberchef .
docker run --rm --name cyberchef -it -p 8080:8080 cyberchef
```
## How it works
There are four main areas in CyberChef:
@ -114,6 +103,17 @@ An installation walkthrough, how-to guides for adding new operations and themes,
- Submit a pull request. If you are doing this for the first time, you will be prompted to sign the [GCHQ Contributor Licence Agreement](https://cla-assistant.io/gchq/CyberChef) via the CLA assistant on the pull request. This will also ask whether you are happy for GCHQ to contact you about a token of thanks for your contribution, or about job opportunities at GCHQ.
## Running in Docker
If you would like to run the app locally in docker please follow the steps below:
```
git clone https://github.com/gchq/CyberChef.git
cd CyberChef
docker build --tag cyberchef .
docker run --rm --name cyberchef -it -p 8080:8080 cyberchef
```
## Licencing
CyberChef is released under the [Apache 2.0 Licence](https://www.apache.org/licenses/LICENSE-2.0) and is covered by [Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/).