Skip to content

Commit cbfbc45

Browse files
authored
docs: add professional README with unified template (#11)
Standardize README.md with a consistent template including CI badge, features, installation, quick start, configuration, and documentation sections. Add paths-ignore to ci.yml to skip CI for docs-only changes.
1 parent b147c51 commit cbfbc45

2 files changed

Lines changed: 81 additions & 355 deletions

File tree

.github/workflows/ci.yml

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,22 @@ name: CI
22
on:
33
push:
44
branches: [develop]
5+
paths-ignore:
6+
- '**.md'
7+
- 'docs/**'
8+
- 'tutorials/**'
9+
- 'examples/**/README.md'
10+
- 'LICENSE'
11+
- '.gitignore'
512
pull_request:
613
branches: [develop, main]
14+
paths-ignore:
15+
- '**.md'
16+
- 'docs/**'
17+
- 'tutorials/**'
18+
- 'examples/**/README.md'
19+
- 'LICENSE'
20+
- '.gitignore'
721
workflow_dispatch:
822
inputs:
923
triggered-by:
@@ -13,10 +27,5 @@ on:
1327
jobs:
1428
build:
1529
uses: fireflyframework/.github/.github/workflows/java-ci.yml@main
16-
permissions:
17-
packages: read
18-
contents: read
19-
actions: write
2030
with:
2131
java-version: '25'
22-
secrets: inherit

0 commit comments

Comments
 (0)