From a8d101bef8685572b86bf20b98df67e514afff32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ey=C3=BCp=20Erdo=C4=9Fan?= Date: Wed, 2 Oct 2024 15:54:11 +0300 Subject: [PATCH] Update README.md --- docs/README.md | 42 +++--------------------------------------- 1 file changed, 3 insertions(+), 39 deletions(-) diff --git a/docs/README.md b/docs/README.md index 0c6c2c2..1f796dc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,41 +1,5 @@ -# Website +# nx-angular-svg-loaders -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +[![SVG Loaders Preview](https://github.com/ngeenx/nx-svg-loaders/blob/main/docs/static/img/nx-svg-loaders-preview.gif?raw=true)](https://ngeenx.github.io/nx-svg-loaders/) -### Installation - -``` -$ yarn -``` - -### Local Development - -``` -$ yarn start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -### Build - -``` -$ yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### Deployment - -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +Angular, React, Svelte, Vue SVG loader collection. Please check the **[documentation](https://ngeenx.github.io/nx-svg-loaders/)** for installation and usage.