Skip to content

Commit

Permalink
Remove README from root
Browse files Browse the repository at this point in the history
  • Loading branch information
klzns committed Dec 27, 2019
1 parent 0753da6 commit 23c50f1
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 210 deletions.
207 changes: 0 additions & 207 deletions README.md

This file was deleted.

File renamed without changes.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ All Store icons components.

## Concept

This project is based on [SVG fragment identifiers](https://css-tricks.com/svg-fragment-identifiers-work/). All store icons are served by Render SDK, and with HTML tag `<use>` we can render a fragment from our icon pack. If you want to know the complete list of fragment SVG's, [see here](https://github.com/vtex-apps/store-icons/blob/master/ICONPACK.md)
This project is based on [SVG fragment identifiers](https://css-tricks.com/svg-fragment-identifiers-work/). All store icons are served by Render SDK, and with HTML tag `<use>` we can render a fragment from our icon pack. If you want to know the complete list of fragment SVG's, [see here](https://github.com/vtex-apps/store-icons/blob/master/docs/ICONPACK.md)

## Usage

Expand Down Expand Up @@ -166,7 +166,7 @@ In the [usage](#usage) section, we discuss two ways of using icons. These ways e

### Overwriting the default IconPack

As mentioned before, all icon IDs are stored at the [iconpack.svg](https://github.com/vtex-apps/store-icons/blob/master/ICONPACK.md) file. You can overwrite the default one by:
As mentioned before, all icon IDs are stored at the [iconpack.svg](https://github.com/vtex-apps/store-icons/blob/master/docs/ICONPACK.md) file. You can overwrite the default one by:

1. On your [`store-theme`](https://github.com/vtex-apps/store-theme/tree/master/styles) create a new folder called `iconpacks`

Expand Down
2 changes: 1 addition & 1 deletion docs/script/scrap-svg.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ $('g').toArray().map(element => {
})

const BASELINE_PATH = path.join(__dirname, 'baseline.md')
const ICONPACK_PATH = path.join(__dirname, '..', '..', 'ICONPACK.md')
const ICONPACK_PATH = path.join(__dirname, '..', 'ICONPACK.md')

fs.copyFile(BASELINE_PATH, ICONPACK_PATH, (err) => {
if (err) throw err
Expand Down

0 comments on commit 23c50f1

Please sign in to comment.