Skip to content

Commit

Permalink
docs: update README, add share demos
Browse files Browse the repository at this point in the history
  • Loading branch information
CatsJuice committed Jul 23, 2023
1 parent be0ee53 commit ec60525
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,31 @@
<p align="center">
<img src="./public/demos/svg-drawing.svg" />
</p>

# svg-drawing

A simple canvas to draw lines and replay rendered as SVG, can be exported as SVG.

# WIP
# Features

- **Share**
Share your drawing with a url that contains all the information to replay it, it's limited, see [Problems](#problems). Some share examples [here](./SHARE.md).
- **Brushwork**
The brushwork's implementation is based on [perfect-freehand](https://github.com/steveruizok/perfect-freehand)

# Problems

It's just a basic implementation, it's not optimized and it's not finished.
- Share limit
The share link contains all points that you draw, because of the limitation of url length(may be different with browsers), the share info maybe lost, and info cannot be parsed.
- Rendering problems at line intersections.
When brushwork enabled, it will use mask to implement the effect ( which is inspired by [AntFu](https://github.com/antfu)'s [Animated SVG Logo](https://antfu.me/posts/animated-svg-logo) ). So this problem is hard to resolve for now.

# Roadmap

- [x] Basic Canvas, replay and export
- [ ] Logo
- [ ] README
- [ ] Canvas size configuration
- [x] README
- [x] Canvas size configuration
- [x] Realtime preview
- [x] Preview as thumbnail
- [x] Full screen / Original size preview
Expand All @@ -32,3 +46,4 @@ It's just a basic implementation, it's not optimized and it's not finished.
- See https://github.com/steveruizok/perfect-freehand
- [ ] <span style="text-decoration: line-through">Import & Export</span>
- [x] Share url
- [ ] Copy svg base64
Loading

0 comments on commit ec60525

Please sign in to comment.