|
1 | | -Picto is being rewritten. The old version is available on the old branch for archival purposes. |
| 1 | + |
| 2 | + |
| 3 | +Send doodles to your friends and chat with Picto, the scribble-powered online messenger. |
| 4 | + |
| 5 | + [](https://twitter.com/PictoTweets) |
| 6 | + |
| 7 | +## :memo: About Picto |
| 8 | + |
| 9 | +Picto is a drawing-based chat client, built with Vue.js and Golang. It makes use of WebSockets for real-time updates, and modern browser technologies for responsive, fluid design. |
| 10 | + |
| 11 | +Go was chosen for the back-end for it's performance and low memory usage, in comparison with Node.js. |
| 12 | + |
| 13 | +### Usage |
| 14 | + |
| 15 | +Get started with Picto by joining or creating a room. Share the room you're in and invite friends with one click on the user icon in the top left. |
| 16 | + |
| 17 | +To doodle, select the pencil tool and use a finger or your mouse to draw in the message box at the bottom of the screen. Typing is also supported, and on mobile tap the keyboard icon to show an on-screen keyboard. |
| 18 | + |
| 19 | +To leave the room, click the open door icon. |
| 20 | + |
| 21 | +## :bookmark_tabs: Documentation |
| 22 | + |
| 23 | +All documentation can either be found in this document ([README.md](README.md)) or in the [docs folder](docs). |
| 24 | + |
| 25 | +- [websocket.md](docs/websocket.md) contains information about the websocket protocol. |
| 26 | +- [api-public.md](docs/api-public.md) contains information about the public HTTP API. |
| 27 | +- [api-private.md](docs/api-private.md) contains information about the private HTTP API. |
| 28 | + |
| 29 | +## :beetle: Issues |
| 30 | + |
| 31 | +Found a bug? Please report it [here](https://github.com/onfe/Picto/issues?q=is%3Aissue+is%3Aopen+label%3Abug) so we can fix it. |
| 32 | + |
| 33 | +If you want to help [fix an issue](https://github.com/onfe/Picto/labels/good%20first%20issue), shoot us a message or open a pull request and we'll get back to you. |
| 34 | + |
| 35 | +## :wave: Credit and thanks |
| 36 | + |
| 37 | +Picto is developed and maintained by: |
| 38 | + |
| 39 | +- Edward (onfe) - https://onfe.uk/ |
| 40 | +- Josh (TheTeaCat) - https://joshuarainbow.co.uk/ |
| 41 | +- Freddy - https://freddyheppell.com/ |
| 42 | + |
| 43 | +Thanks to all our friends and families who dealt with the late nights, tested Picto, shared it around and provided support and enthusiasm. |
| 44 | + |
| 45 | +:triangular_flag_on_post: Icons by [Font Awesome](https://fontawesome.com/) |
0 commit comments