making basic functionality work & add todo list to readme

This commit is contained in:
Michi 2024-11-06 21:42:09 +01:00
parent f32a3b56ce
commit a84d0a512e
5 changed files with 88 additions and 18 deletions

View file

@ -1,2 +1,20 @@
# click-guide
A browser add-on which records the steps clicked on a page and generates a easy to understand guide from it.
Similar to tango.us/dubble.so/folge.me/magichow.co but all local - no data leaves your device
## To-Do MVP:
- [x] identify element selector or id
- [x] create a screenshot of the steps
- [x] ability to save multiple steps
- [x] export guide as json file
- [ ] add recording start/stop functionality
- [ ] create basic popup UI
### Additional nice to have:
- [ ] Viewer for Guide JSON
- [ ] Editor for Guide
- [ ] improve error handling
### Maybe far in the future:
- [ ] Optional cloud for sharing guide as link