diff --git a/README.md b/README.md index e62e093e7092d1069ce0eb8f8497a66475e45d0b..63742912751141bd6d93aa80b4c1789725ae4176 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -# Vue 3 + Vite +# AFC Dons Vue 3 + Vite -This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more. +This is a rebuilt of afcdons.net (originally PHP) using Vue 3 and vite and the Composition API. I have mainly worked with Vue 2 and Options API so I would accept any suggestions where I maybe stepping away from best practice. I however do not want to use typescript + +## Why ? + +This is a good way for me to learn Vue 3 and Composition API as I know the components needed. It also will allow me to add new features + +## Propsed New Features + +- remove commenting on news and add emoji reactions, no one comments anymore +- add a new predication slides so you can at anytime predict the league table based on current form. ## Recommended IDE Setup -- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). +- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + +## Code contributions + +Please use Prettier and ESLint and set up to remove semi colons and use single quotes.