elk/README.md

25 lines
1 KiB
Markdown
Raw Normal View History

2022-11-23 13:06:27 +00:00
# Elk
2022-11-13 05:34:43 +00:00
2022-11-24 11:03:58 +00:00
![Elk Logo](https://elk.zone/logo.svg)
2022-11-24 10:53:23 +00:00
2022-11-24 11:03:58 +00:00
A nimble Mastodon web client made with 💛
2022-11-13 05:34:43 +00:00
2022-11-24 10:46:03 +00:00
Elk is in early alpha, but it is already quite usable. We would love your feedback and contributions.
2022-11-24 10:53:23 +00:00
Check out the [Open Issues](https://github.com/elk-zone/elk/issues) and jump in the action. Join the [Elk discord server](https://discord.gg/vAZSDU9J) to learn more and get involved!
2022-11-24 10:46:03 +00:00
The client is deployed to [elk.zone](https://elk.zone), you can share screenshots on social media but avoid sharing this URL or the discord server until we open the repo.
2022-11-24 10:53:23 +00:00
If you would like to contribute, until the repo is open, please create branches in the main repository and send a PR from there.
2022-11-24 11:03:58 +00:00
# Stack
- [Nuxt](https://nuxtjs.org/) - The Intuitive Vue Framework
- [Pinia](https://pinia.vuejs.org/) - The Vue Store that you will enjoy using
- [UnoCSS](https://uno.antfu.me/) - The instant on-demand atomic CSS engine
- [Masto.js](https://neet.github.io/masto.js) - Mastodon API client for JavaScript, TypeScript, Node.js, browsers
2022-11-24 10:53:23 +00:00
# License
MIT