diff --git a/README.md b/README.md index 1c017f0..b795934 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # Hyper -Starter template for marketing and eCommerce websites. Powered by Alpine.js and Hyper UI. + +Starter template for marketing and eCommerce websites. Powered by [Alpine.js](https://alpinejs.dev/) and [HyperUI](https://www.hyperui.dev/). + +[![Netlify](https://api.netlify.com/api/v1/badges/9e78fafd-cc22-4b25-b00d-f5628eb52ce2/deploy-status)](https://app.netlify.com/sites/hyper-template/deploys) + +![screenshot](./src/images/covers/screenshot.png) + +### Quickstart + +- [click here](https://github.com/new?template_name=Hyper&template_owner=rayc2045) to use this template, or clone this repo locally: `git clone https://github.com/rayc2045/Hyper` +- download [Live Server](https://www.npmjs.com/package/live-server) and run `live-server` + +### Deploy + +- [Netlify](https://app.netlify.com/sites/hyper-template/) +- [GitHub Pages](https://rayc2045.github.io/Hyper/) diff --git a/src/images/covers/screenshot.png b/src/images/covers/screenshot.png new file mode 100644 index 0000000..30aa63c Binary files /dev/null and b/src/images/covers/screenshot.png differ