Skip to content

Commit 0a5fada

Browse files
authored
Add usage example to README
Added usage example section with a GIF.
1 parent b43dd1e commit 0a5fada

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ codewiki generate --github-pages --create-branch
6565

6666
**That's it!** Your documentation will be generated in `./docs/` with comprehensive repository-level analysis.
6767

68+
### Usage Example
69+
70+
![CLI Usage Example](https://github.com/FSoft-AI4Code/CodeWiki/releases/download/assets/cli-usage-example.gif)
71+
6872
---
6973

7074
## What is CodeWiki?
@@ -277,4 +281,4 @@ If you use CodeWiki in your research, please cite:
277281

278282
## License
279283

280-
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
284+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

0 commit comments

Comments
 (0)