Skip to content

Commit e64f571

Browse files
committed
docs: adjust commands to redirect to expected file locations
1 parent 400d7a0 commit e64f571

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Before getting started, make sure you have a development workspace where you hav
1010

1111
1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and choose "From an app manifest"
1212
2. Choose the workspace you want to install the application to
13-
3. Copy the contents of [manifest.json](./manifest.json) into the text box that says `*Paste your manifest code here*` (within the JSON tab) and click *Next*
14-
4. Review the configuration and click *Create*
15-
5. Click *Install to Workspace* and *Allow* on the screen that follows. You'll then be redirected to the App Configuration dashboard.
13+
3. Copy the contents of [manifest.json](./manifest.json) into the text box that says `*Paste your manifest code here*` (within the JSON tab) and click _Next_
14+
4. Review the configuration and click _Create_
15+
5. Click _Install to Workspace_ and _Allow_ on the screen that follows. You'll then be redirected to the App Configuration dashboard.
1616

1717
#### Environment Variables
1818

@@ -34,13 +34,14 @@ export SLACK_APP_TOKEN=<your-app-token>
3434
git clone https://github.com/slack-samples/bolt-java-starter-template.git
3535

3636
# Change into this project directory
37-
cd bolt-java-template
37+
cd bolt-java-starter-template
3838
```
3939

4040
#### Maven: Run
4141

4242
Ensure [maven](https://maven.apache.org/index.html) is installed on your local environment.
43-
* We recommend using [brew to install Maven on macOS](https://formulae.brew.sh/formula/maven)
43+
44+
- We recommend using [brew to install Maven on macOS](https://formulae.brew.sh/formula/maven)
4445

4546
```zsh
4647
# Install the dependencies and compile
@@ -56,14 +57,15 @@ mvn clean test
5657
mvn clean compile exec:java -Dexec.mainClass="Main"
5758
```
5859

59-
**NOTE**: If you chose to use Maven as your build tool you can remove the `builde.gradle` file from this project.
60+
**NOTE**: If you chose to use Maven as your build tool you can remove the `build.gradle` file from this project.
6061

61-
------
62+
---
6263

6364
#### Gradle: Run
6465

6566
Ensure [gradle](https://gradle.org/) is installed on your local environment.
66-
* We recommend using [brew to install Gradle on macOS](https://formulae.brew.sh/formula/gradle)
67+
68+
- We recommend using [brew to install Gradle on macOS](https://formulae.brew.sh/formula/gradle)
6769

6870
```zsh
6971
# Run tests
@@ -124,4 +126,4 @@ Navigate to **OAuth & Permissions** in your app configuration and click **Add a
124126
https://3cb89939.ngrok.io/slack/oauth/callback
125127
```
126128

127-
*NOTE:* if you do not require OAuth you can remove all `OAUTH DEPENDENCIES` in the `pom.xml` or `build.gradle` files, along with `src/main/java/OAuthMain.java`
129+
_NOTE:_ if you do not require OAuth you can remove all `OAUTH DEPENDENCIES` in the `pom.xml` or `build.gradle` files, along with `src/main/java/OAuthMain.java`

0 commit comments

Comments
 (0)