Skip to content

Commit

Permalink
[Doc] add introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
mistricky committed Oct 25, 2024
1 parent 10409ca commit 723e7d5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
<img width="350" src="/doc/logo.png" />

## CodeSnap
CodeSnap is a pure Rust tool for generate beautiful code snapshots, it directly use graphic engine to generate snapshots, which means the entire process is just matter of computation and rendering, without need for network or something like browser-based rendering solution.

Generally, you can directly use CLI tool provide by CodeSnap to generate code snapshots you want. Or CodeSnap also provide a library for you to integrate it into your own project, so you can generate code snapshots in your own way (See [Related projects](#) for more information).

## Related projects
- [codesnap-cli]()
- [codesnap.nvim]()


## License
MIT.

0 comments on commit 723e7d5

Please sign in to comment.