Skip to content

Commit 30a027c

Browse files
authored
Add usage part
1 parent 458e08f commit 30a027c

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99

1010
Provides SCM-Manager metrics as json.
1111

12+
## Usage
13+
14+
Find out how this plugin can be used on the [user documentation page](https://scm-manager.org/plugins/scm-metrics-json-plugin/docs).
15+
1216
## Build and testing
1317

1418
The plugin can be compiled and packaged with the normal maven lifecycle:
@@ -30,7 +34,7 @@ If the plugin was started with `gradle run`, the default browser of the os shoul
3034
If the browser does not start automatically, start it manually and go to [http://localhost:8081/scm](http://localhost:8081/scm).
3135

3236
In this mode each change to web files (src/main/js or src/main/webapp), should trigger reload of the browser with the made changes.
33-
If you compile a class (e.g.: with your IDE from src/main/java to target/classes),
37+
If you compile a class (e.g.: with your IDE from src/main/java to target/classes),
3438
the SCM-Manager context will restart automatically. So you can see your changes without restarting the server.
3539

3640
## Directory & File structure
@@ -54,7 +58,7 @@ A quick look at the files and directories you'll see in a SCM-Manager project.
5458
├── CHANGELOG.md
5559
├── gradle.properties
5660
├── gradlew
57-
├── LICENSE
61+
├── LICENSE.txt
5862
├── package.json
5963
├── README.md
6064
├── settings.gradle
@@ -64,15 +68,15 @@ A quick look at the files and directories you'll see in a SCM-Manager project.
6468
1. **`node_modules/`**: This directory contains all modules of code that your project depends on (npm packages) are automatically installed.
6569

6670
2. **`src/`**: This directory will contain all code related to what you see or not. `src` is a convention for “source code”.
67-
1. **`main/`**
68-
1. **`java/`**: This directory contains the Java code.
69-
2. **`js/`**: This directory contains the JavaScript code for the web ui, inclusive unit tests: suffixed with `.test.ts`
70-
3. **`resources/`**: This directory contains the classpath resources.
71-
2. **`test/`**
72-
1. **`java/`**: This directory contains the Java unit tests.
73-
3. **`resources/`**: This directory contains classpath resources for unit tests.
74-
3. **`target/`**: This is the build directory.
75-
71+
1. **`main/`**
72+
1. **`java/`**: This directory contains the Java code.
73+
2. **`js/`**: This directory contains the JavaScript code for the web ui, inclusive unit tests: suffixed with `.test.ts`
74+
3. **`resources/`**: This directory contains the classpath resources.
75+
2. **`test/`**
76+
1. **`java/`**: This directory contains the Java unit tests.
77+
3. **`resources/`**: This directory contains classpath resources for unit tests.
78+
3. **`target/`**: This is the build directory.
79+
7680
3. **`.editorconfig`**: This is a configuration file for your editor using [EditorConfig](https://editorconfig.org/). The file specifies a style that IDEs use for code.
7781

7882
4. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
@@ -85,12 +89,12 @@ A quick look at the files and directories you'll see in a SCM-Manager project.
8589

8690
8. **`gradlew`**: Bundled gradle wrapper if you don`t have gradle installed.
8791

88-
9. **`LICENSE`**: This project is licensed under the MIT license.
92+
9. **`LICENSE.txt`**: This project is licensed under the MIT license.
8993

9094
10. **`package.json`**: Here you can find the dependency/build configuration and dependencies for the frontend.
9195

9296
11. **`README.md`**: This file, containing useful reference information about the project.
93-
97+
9498
12. **`settings.gradle`**: Gradle settings configuration.
9599

96100
13. **`tsconfig.json`** This is the typescript configuration file.

0 commit comments

Comments
 (0)