From 7a148353bba615bf749d647d4cf8b8770f662482 Mon Sep 17 00:00:00 2001 From: misitebao Date: Fri, 6 May 2022 12:30:34 +0800 Subject: [PATCH] docs: update contributors list --- .github/README.md | 1 + .github/README.zh-Hans.md | 1 + README.md | 191 -------------------------------------- 3 files changed, 2 insertions(+), 191 deletions(-) delete mode 100644 README.md diff --git a/.github/README.md b/.github/README.md index 410cfe4..c82372b 100644 --- a/.github/README.md +++ b/.github/README.md @@ -152,6 +152,7 @@ Thanks to the maintainers of these projects: Thank you to all the contributors who participated in the development of wails-template-vue. [Contributors](https://github.com/misitebao/wails-template-vue/graphs/contributors) crushonyou18 +daoif diff --git a/.github/README.zh-Hans.md b/.github/README.zh-Hans.md index fb53d7a..34e1f1f 100644 --- a/.github/README.zh-Hans.md +++ b/.github/README.zh-Hans.md @@ -151,6 +151,7 @@ wails init -n [你的应用名称] -t https://github.com/misitebao/wails-templat 感谢所有参与 wails-template-vue 开发的贡献者。[贡献者列表](https://github.com/misitebao/wails-template-vue/graphs/contributors) crushonyou18 +daoif diff --git a/README.md b/README.md deleted file mode 100644 index 684d74f..0000000 --- a/README.md +++ /dev/null @@ -1,191 +0,0 @@ -

- -

-

- A Wails template based on Vue and Vue-Router -

-

- - GitHub - - - GitHub - - - GitHub Repo stars - - - GitHub release (latest by date including pre-releases) - - - GitHub user - - - Gitter - - - Awesome-Wails - - -

- - - -## Internationalization - -[English](README.md) | [简体中文](./.github/README.zh-Hans.md) - - - -## Table of Contents - -
- Click me to Open/Close the directory listing - -- [Internationalization](#nav-1) -- [Table of Contents](#nav-2) -- [Introductions](#nav-3) - - [Official Website](#nav-3-1) - - [Background](#nav-3-2) -- [Graphic Demo](#nav-4) -- [Features](#nav-5) -- [Architecture](#nav-6) -- [Getting Started](#nav-7) -- [Maintainer](#nav-8) -- [Contributors](#nav-9) -- [Community Exchange](#nav-10) -- [Part Of Users](#nav-11) -- [Release History](CHANGE.md) -- [Donators](#nav-12) -- [Sponsors](#nav-13) -- [Special Thanks](#nav-14) -- [License](#nav-15) - -
- - - -## Introductions - -The wails-template-vue template is a Vue template that supports [Wails](https://github.com/wailsapp/wails) programs and provides Router and i18n functions by default. - - - - - - - -### Background - -I hope that Vue and its powerful community ecology can be used in Wails applications to develop single-page applications that support multiple routes. - - - -## Graphic Demo - -[![Demo Screenshot](https://cdn.jsdelivr.net/gh/misitebao/wails-template-vue@main/.github/preview.en.png "click to view gif demo")](https://cdn.jsdelivr.net/gh/misitebao/wails-template-vue@main/.github/preview.gif) - - - -## Features - -- Compatible with Windows, MacOS, Linux platforms -- Support single page routing and i18n. -- Built-in Sass preprocessor. -- A consistent UI experience across platforms(Comes with JetbrainsMono font package). -- Comes with a complete API example(Currently under development and testing...). -- Support JavaScript and TypeScript - - - - - - - -## Getting Started - -### New Project - -``` -wails init -n [Your Appname] -t https://github.com/misitebao/wails-template-vue -``` - -flag description: - -- n - The name of the application to be created -- t - Template name, supports built-in template names and third-party templates in the form of hyperlinks - -After the project is created, the JavaScript template is used by default. You can change the value of the `"frontend:build"` field in the `wails.json` file to `"npm run build -w ts"` to use the TypeScript template. - -Note: In order to support TypeScript templates under the existing functions, the front-end part uses the NPM workspace function, so the NPM version must be `>=7.0.0`, please run `npm -v` to check your NPM version. - -### Reference document - -The front-end part uses Vue Vue-Router and Vue-I18N: - -- Vue - Use vue3.x version, please refer to the official [Vue3.x Documents](https://v3.vuejs.org/guide/introduction.html) for specific usage. -- Vue-Router - Use Vue-Router 4.x version, please refer to the official [Vue-Router Documents](https://next.router.vuejs.org/) for specific usage. -- Vue-I18N - Use Vue-I18N 9.x version, please refer to official [Vue-I18N Documents](https://vue-i18n.intlify.dev/) for specific usage. -- TypeScript - Please refer to official [TypeScript Documents](https://www.typescriptlang.org/) for specific usage. - -Then you can refer to the official [Wails document](https://wails.io) to start developing your application🤞. - - - -## Maintainer - -Thanks to the maintainers of these projects: - -misitebao - -
- Click me to Open/Close the maintainer listing - -- [Misitebao](https://github.com/misitebao) - Project author, full stack engineer. - -
- - - -## Contributors - -Thank you to all the contributors who participated in the development of wails-template-vue. [Contributors](https://github.com/misitebao/wails-template-vue/graphs/contributors) - -crushonyou18 - - - -## Community Exchange - -- [Github Discussions](https://github.com/wailsapp/wails/discussions) - The official Github communication community of the Wails project -- [Wails Slack](https://invite.slack.golangbridge.org/) - Wails official communication channel -- [Twitter](https://twitter.com/wailsapp) - Wails official Twitter account - -Chinese Community: - -- QQ Group: 1067173054 - QQ Chinese Community Exchange Group - - - -## Part Of Users - -- [Wails API Demos](https://github.com/misitebao/wails-api-demos) - A sample program for exploring Wails API, inspired by [Electron API Demos](https://github.com/electron/electron-api-demos) -- [Hayate](https://github.com/misitebao/hayate) - Windows application installation boot program implemented using Wails. - - - - - - - - - - - - - - - -## License - -[License MIT](./LICENSE)