Skip to content

Commit 6dc6fee

Browse files
committed
Revise the Usage section in README
1 parent 66376d4 commit 6dc6fee

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,41 @@ e.g. HTML Escape / URL Encoding / Base64 / MD5 / SHA-1 / CRC32 / and many other
77
[https://dencode.com/](https://dencode.com/)
88

99
## Usage
10-
Install [Java SE Development Kit (JDK)](https://www.oracle.com/java/technologies/downloads/).
1110

12-
Open a shell or command line and execute the following commands on the project root directory.
11+
### Use DenCode online:
12+
You can use DenCode online without downloading it.
1313

14-
### Run on local machine:
14+
[https://dencode.com/](https://dencode.com/)
1515

16-
```console
17-
./gradlew runApp
16+
### Run using Docker:
17+
With [Docker](https://www.docker.com/), you can run DenCode wherever you want.
18+
19+
```bash
20+
docker run -p 8080:8080 ghcr.io/mozq/dencode-web:latest
1821
```
1922

2023
After startup, DenCode can be accessed at http://localhost:8080/ .
2124

22-
### Run using docker:
25+
### Build using Gradle:
26+
If you want to build DenCode from the source code yourself, use [Gradle](https://gradle.org/) within the project.
27+
Install [Java SE Development Kit (JDK)](https://www.oracle.com/java/technologies/downloads/) and run the following command on the project root directory.
28+
Build artifacts are stored in build/app/ directory.
29+
2330
```bash
24-
docker run -p 8080:8080 ghcr.io/mozq/dencode-web:latest
31+
./gradlew build
2532
```
2633

27-
### Deploy to Google App Engine:
34+
If you want to run DenCode as well, run the following command.
2835

29-
Install [Google Cloud SDK](https://cloud.google.com/sdk/) and execute the following commands. First two commands, `gcloud auth` and `gcloud config`, only needs to be executed for the first time.
36+
```bash
37+
./gradlew runApp
38+
```
3039

31-
```console
40+
### Deploy to Google App Engine:
41+
Install [Google Cloud SDK](https://cloud.google.com/sdk/) and run the following commands.
42+
First two commands, `gcloud auth` and `gcloud config`, only needs to be ran for the first time.
43+
44+
```bash
3245
gcloud auth login
3346
gcloud config set project {PROJECT_ID}
3447

0 commit comments

Comments
 (0)