Skip to content

Commit

Permalink
docs(readme): update folder structure + npm-dist tag
Browse files Browse the repository at this point in the history
  • Loading branch information
bartholomej committed Jan 5, 2020
1 parent 776e978 commit 9832de7
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 9832de7

Please sign in to comment.