From ebd021627883bd0edcc4581625de6953431bfd55 Mon Sep 17 00:00:00 2001 From: Stanislav Romanov Date: Sat, 20 May 2023 07:21:57 +0300 Subject: [PATCH] Add "How to use it" --- DEVELOPMENT.md | 5 +++-- README.md | 6 ++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index d303699..c40e530 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -35,8 +35,9 @@ Make use of the many generators for code, try `ember help generate` for more det ### Building -* `ember build` (development) -* `ember build --environment production` (production) +* `npm start` (development and watch) +* `npm run build` (production) +* `ROOTURL=/admin/ npm run build` (production build with rooturl, example: https://example.com/admin/) ## Further Reading / Useful Links diff --git a/README.md b/README.md index 3fdf464..be84052 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,12 @@ - ✅ Validation for json settings - 🌙 Dark mode +## How to use it +Meiliadmin is an [Ember](https://emberjs.com/) application. There are some way for use it: +1. Just use the [demo](https://kaermorchen.github.io/meiliadmin/) page with your meilisearch instance. +1. Install it in you domain, extract the asset `dist.tgz` from the [latest realese](https://github.com/kaermorchen/meiliadmin/releases/latest). +1. For custom building the app, see the [development page](DEVELOPMENT.md#building). + ## Screenshots ![start](https://github.com/kaermorchen/meiliadmin/assets/11972062/29507812-d9d9-4cc0-8f9c-400c98fdd064)