Skip to content

Commit 98700f0

Browse files
committed
Cosmetics for release
1 parent a7cdd3b commit 98700f0

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# CodeBoarding [Diagram-First Documentation]
2-
3-
[![GitHub Action](https://img.shields.io/badge/GitHub-Action-blue?logo=github-actions)](https://github.com/marketplace/actions/codeboarding-diagram-first-documentation)
1+
<div align="center">
2+
<img src="assets/icon.svg" alt="CodeBoarding Logo" height="150" />
3+
4+
# CodeBoarding [Diagram-First Documentation]
5+
6+
[![GitHub Action](https://img.shields.io/badge/GitHub-Action-blue?logo=github-actions)](https://github.com/marketplace/actions/codeboarding-diagram-first-documentation)
7+
</div>
48

59
Generates diagram-first visualizations of your codebase using static analysis and large language models.
610

@@ -38,7 +42,7 @@ jobs:
3842
3943
| Input | Description | Required | Default |
4044
|-------|-------------|----------|---------|
41-
| `repository_url` | Repository URL to fetch documentation for | Yes | - |
45+
| `repository_url` | Repository URL for which documentation will be generated | Yes | - |
4246
| `output_directory` | Directory where documentation files will be saved | No | `.codeboarding` |
4347

4448
## Outputs

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: 'Generates diagram-first visualizations of your codebase using stat
33
author: 'CodeBoarding'
44

55
branding:
6-
icon: 'file-text'
6+
icon: 'book-open' # or 'layers', 'git-branch', 'book-open', 'target'
77
color: 'blue'
88

99
inputs:

assets/icon.svg

Lines changed: 9 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)