From bf60ca05fa2e3a8a4a8893e8a817f78e0bef41f4 Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Wed, 11 Jan 2023 22:58:03 +0100 Subject: [PATCH 01/11] docs: update sponsorship --- .github/FUNDING.yml | 3 ++- README.md | 28 ++++++++++++++++++---------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 8abe4458..4ef6738c 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1,2 @@ -github: [antfu, patak-dev, sxzz, danielroe] +github: [elk-zone] +open_collective: elk diff --git a/README.md b/README.md index 013c1665..eb74dfb2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ -# Elk -*A nimble Mastodon web client* -

- Elk logo + Elk logo

+ +

Elk alpha

+ +

+A nimble Mastodon web client +

+

discord chat @@ -13,7 +17,7 @@


-# Elk is in early alpha ⚠️ +## ⚗️ Elk is in Early Alpha ⚠️ It is already quite usable, but it isn't ready for wide adoption yet. We recommend you to use it if you would like to help us build it. We appreciate your feedback and contributions. Check out the [Open Issues](https://github.com/elk-zone/elk/issues) and jump in the action. Join the [Elk discord server](https://chat.elk.zone) to chat with us and learn more about the project. @@ -24,7 +28,7 @@ The client is deployed on: You can share screenshots on social media but we prefer you avoid sharing this URL directly until the app is more polished. Feel free to share the URL with your friends and invite others you think could be interested in helping to improve Elk. -## Sponsors +## 💖 Sponsors We want to thanks the generous sponsoring and help of: @@ -39,6 +43,10 @@ We want to thanks the generous sponsoring and help of: And all the companies and individuals sponsoring Elk Team members. If you're enjoying the app, consider sponsoring our team: +- [Elk Team's GitHub Sponsors](https://github.com/sponsors/elk-zone) + +Or you can sponsors our core team members individually: + - [Anthony Fu](https://github.com/sponsors/antfu) - [Daniel Roe](https://github.com/sponsors/danielroe) - [三咲智子 Kevin Deng](https://github.com/sponsors/sxzz) @@ -46,11 +54,11 @@ And all the companies and individuals sponsoring Elk Team members. If you're enj We would also appreciate sponsoring other contributors to the Elk project. If someone helps you solve an issue or implement a feature you wanted, supporting them would help make this project and OS more sustainable. -## Roadmap +## 📍 Roadmap [Open board on Volta](https://volta.net/elk-zone/elk) -## Contributing +## 🧑‍💻 Contributing We're really excited that you're interested in contributing to Elk! Before submitting your contribution, please read through the following guide. @@ -86,7 +94,7 @@ Elk uses [Vitest](https://vitest.dev). You can run the test suite with: nr test ``` -## Stack +## 🦄 Stack - [Vite](https://vitejs.dev/) - Next Generation Frontend Tooling - [Nuxt](https://nuxt.com/) - The Intuitive Web Framework @@ -100,6 +108,6 @@ nr test - [shiki](https://shiki.matsu.io/) - A beautiful Syntax Highlighter - [vite-plugin-pwa](https://github.com/vite-pwa/vite-plugin-pwa) - Prompt for update and push notifications -## License +## 📄 License [MIT](./LICENSE) © 2022-PRESENT Elk contributors From 2b3b5fe4cb02f52fc65febd4fdb214747f6df576 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Wed, 11 Jan 2023 22:13:46 +0000 Subject: [PATCH 02/11] chore: fix some typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eb74dfb2..9debeaf7 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ A nimble Mastodon web client ## ⚗️ Elk is in Early Alpha ⚠️ -It is already quite usable, but it isn't ready for wide adoption yet. We recommend you to use it if you would like to help us build it. We appreciate your feedback and contributions. Check out the [Open Issues](https://github.com/elk-zone/elk/issues) and jump in the action. Join the [Elk discord server](https://chat.elk.zone) to chat with us and learn more about the project. +It is already quite usable, but it isn't ready for wide adoption yet. We recommend you use it if you would like to help us build it. We appreciate your feedback and contributions. Check out the [Open Issues](https://github.com/elk-zone/elk/issues) and jump in the action. Join the [Elk discord server](https://chat.elk.zone) to chat with us and learn more about the project. The client is deployed on: @@ -30,7 +30,7 @@ You can share screenshots on social media but we prefer you avoid sharing this U ## 💖 Sponsors -We want to thanks the generous sponsoring and help of: +We are grateful for the generous sponsorship and help of: NuxtLabs @@ -45,7 +45,7 @@ And all the companies and individuals sponsoring Elk Team members. If you're enj - [Elk Team's GitHub Sponsors](https://github.com/sponsors/elk-zone) -Or you can sponsors our core team members individually: +Or you can sponsor our core team members individually: - [Anthony Fu](https://github.com/sponsors/antfu) - [Daniel Roe](https://github.com/sponsors/danielroe) From e34bfee4a57f7e609714a36afd2e658f90d4187c Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Wed, 11 Jan 2023 23:24:00 +0100 Subject: [PATCH 03/11] feat: sponsors in about page and nav footer --- README.md | 2 +- components/nav/NavFooter.vue | 10 +++++ components/settings/SettingsItem.vue | 2 +- components/settings/SettingsSponsorsList.vue | 31 ++++++++++++++++ locales/en-US.json | 8 +++- pages/settings/about/index.vue | 39 ++++++++++++++++++-- pages/settings/users/index.vue | 1 + 7 files changed, 86 insertions(+), 7 deletions(-) create mode 100644 components/settings/SettingsSponsorsList.vue diff --git a/README.md b/README.md index 9debeaf7..4da950ff 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ We are grateful for the generous sponsorship and help of:

-And all the companies and individuals sponsoring Elk Team members. If you're enjoying the app, consider sponsoring our team: +And all the companies and individuals sponsoring Elk Team and the members. If you're enjoying the app, consider sponsoring us: - [Elk Team's GitHub Sponsors](https://github.com/sponsors/elk-zone) diff --git a/components/nav/NavFooter.vue b/components/nav/NavFooter.vue index a14a72f6..4da9a96c 100644 --- a/components/nav/NavFooter.vue +++ b/components/nav/NavFooter.vue @@ -26,6 +26,16 @@ function toggleDark() { @click="userSettings.zenMode = !userSettings.zenMode" /> + + +
diff --git a/components/settings/SettingsItem.vue b/components/settings/SettingsItem.vue index cda8029b..59b62882 100644 --- a/components/settings/SettingsItem.vue +++ b/components/settings/SettingsItem.vue @@ -62,7 +62,7 @@ useCommand({ />
-
+

{{ text }} diff --git a/components/settings/SettingsSponsorsList.vue b/components/settings/SettingsSponsorsList.vue new file mode 100644 index 00000000..4f7de041 --- /dev/null +++ b/components/settings/SettingsSponsorsList.vue @@ -0,0 +1,31 @@ + diff --git a/locales/en-US.json b/locales/en-US.json index a4b372ff..0e5b1580 100644 --- a/locales/en-US.json +++ b/locales/en-US.json @@ -236,7 +236,13 @@ "settings": { "about": { "label": "About", - "meet_the_team": "Meet the team" + "meet_the_team": "Meet the team", + "sponsor_action": "Sponsor us", + "sponsor_action_desc": "To support the team developing Elk", + "sponsors": "Sponsors", + "sponsors_body_1": "Elk is made possible thanks the generous sponsoring and help of:", + "sponsors_body_2": "And all the companies and individuals sponsoring Elk Team and the members.", + "sponsors_body_3": "If you're enjoying the app, consider sponsoring us:" }, "account_settings": { "description": "Edit your account settings in Mastodon UI", diff --git a/pages/settings/about/index.vue b/pages/settings/about/index.vue index 5651dee5..a4eb67f2 100644 --- a/pages/settings/about/index.vue +++ b/pages/settings/about/index.vue @@ -54,7 +54,7 @@ const handleShowCommit = () => { @@ -62,27 +62,58 @@ const handleShowCommit = () => { text="Mastodon" icon="i-ri:mastodon-line" to="/m.webtoo.ls/@elk" - external target="_blank" + external large target="_blank" />

+

+ {{ $t('settings.about.sponsors') }} +

+ +

+ {{ $t('settings.about.sponsors_body_1') }} +

+ + + +

+ {{ $t('settings.about.sponsors_body_2') }} +

+

+ {{ $t('settings.about.sponsors_body_3') }} +

+ + + + + +
+