From 95bedb5335e7e7403c49b57c90a19cf695b65bdc Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Mon, 2 Jan 2023 17:01:17 +0100 Subject: [PATCH] docs: sponsors (#689) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: 三咲智子 Kevin Deng Co-authored-by: patak Co-authored-by: userquin --- README.md | 38 ++++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9f1a8a27..8abdf9f1 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,43 @@ It is already quite usable, but it isn't ready for wide adoption yet. We recomme The client is deployed to [elk.zone](https://elk.zone), 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 friedns and invite others you think could be interested in helping to improve Elk. -# Contributing +## Sponsors + +We want to thanks the generous sponsoring and help of: + +
+
+ + NuxtLabs + +
+
+ + StackBlitz + +
+
+ +And all the companies and individuals sponsoring Elk Team members. If you're enjoying the app, consider sponsoring our team: + +- [Anthony Fu](https://github.com/sponsors/antfu) +- [Daniel Roe](https://github.com/sponsors/danielroe) +- [三咲智子 Kevin Deng](https://github.com/sponsors/sxzz) +- [Patak](https://github.com/sponsors/patak-dev) + +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. + +## Contributing We're really excited that you're interested in contributing to Elk! Before submitting your contribution, please read through the following guide. -## Online +### Online You can use [StackBlitz CodeFlow](https://stackblitz.com/codeflow) to fix bugs or implement features. You'll also see a CodeFlow button on PRs to review them without a local setup. Once the elk repo has been cloned in CodeFlow, the dev server will start automatically and print the URL to open the App. You should receive a prompt in the bottom-right suggesting to open it in the Editor or in another Tab. To learn more, check out the [CodeFlow docs](https://developer.stackblitz.com/codeflow/what-is-codeflow). [![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/elk-zone/elk) -## Local Setup +### Local Setup Clone the repository and run on the root folder: @@ -47,7 +73,7 @@ ni nr dev ``` -## Testing +### Testing Elk uses [Vitest](https://vitest.dev). You can run the test suite with: @@ -55,7 +81,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 @@ -69,6 +95,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