Skip to content

DaniFoldi/paintbrush

Repository files navigation

Paintbrush UI

Docs

Visit https://paintbrush.danifoldi.com for the latest version

Install

npm i -D paintbrush-ui

Usage

Most of the "magic" comes from the <Paintbrush> component, which should be wrapping everything else in your page - the best place to use it is in app.vue.

Contributing

Feel free to open Issues for any bugs/visual inconsistencies/glitches that you find. Pull Requests are also welcome, however in this case please use commit names starting with emojis as described below:

Emoji Prefix Description
:zap: for implementing or extending functionality
⚡⚡ :zap::zap: for breaking changes
🔨 :hammer: for bug fixes
🔧 :wrench: for configurations
🚦 :vertical_traffic_light: for tests
📝 :memo: for documentations
🔍 :mag: for lint fixes
♻️ :recycle: for non-breaking refactoring
📎 :paperclip: for dependencies
:octocat: :octocat: for workflows
🚧 :construction: for experimental or temporary changes

Note: WIP

Paintbrush is currently in beta.