From 9832de7360439bc15f38b9578be61bfeab4ce5f8 Mon Sep 17 00:00:00 2001 From: BART! Date: Sun, 5 Jan 2020 09:50:51 +0100 Subject: [PATCH] docs(readme): update folder structure + npm-dist tag --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 95c73bb..f21432e 100644 --- a/README.md +++ b/README.md @@ -115,17 +115,21 @@ material-scrolltop/ ### src/ (for development) -Typescript + sass source files +TypeScript + SCSS source files + +`.ts`, `.scss` + +> which are NOT executable in browser ### dist/ (for production) JavaScript + CSS -(compiled from `src/` folder with command `yarn build`) +> executable in browser and compiled from `src/` folder with command `yarn build` ### demo/ (example page) -Here you can see it in [real use](https://bartholomej.github.io/material-scrolltop/). +In this folder you can see an example in [real use](https://bartholomej.github.io/material-scrolltop/). ## Customization @@ -171,7 +175,7 @@ Version 2.x.x contains some breaking changes: Old version is still available: - Dev branch: [1.x](https://github.com/bartholomej/material-scrolltop/tree/1.x) -- npm package: `yarn add material-scrolltop@1` +- npm package: `yarn add material-scrolltop@1-latest` ## Application