Skip to content

Commit

Permalink
Merge pull request #29 from codex-team/neSpecc-patch-1
Browse files Browse the repository at this point in the history
Readme updated
  • Loading branch information
neSpecc authored Dec 30, 2022
2 parents d835474 + 9c5f712 commit 1dab147
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ Dozens of cute icons made with love by CodeX for your projects.

No dependencies required. Free to use and share.

<img width="1657" alt="image" src="https://user-images.githubusercontent.com/3684889/210104174-93ee88d6-a2ba-44a8-ac22-ee04955c771b.png">


## Usage

Install the package with node package manager.
Install the package with node package manager.

```sh
npm install @codexteam/icons
Expand Down Expand Up @@ -107,3 +110,9 @@ You will get the line: `<svg xmlns="http://www.w3.org/2000/svg" ...`
| ![IconUsersGroup](dist/icons/IconUsersGroup.svg) | `IconUsersGroup` |
| ![IconWarning](dist/icons/IconWarning.svg) | `IconWarning` |
<!-- END TABLE_OF_ICONS -->

## How to add an icon

- Request an icon you need via [an Issue](https://github.com/codex-team/icons/issues/new)
- Or add your icon and open a PR

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@codexteam/icons",
"version": "0.2.0",
"version": "0.2.1-rc.0",
"main": "dist/index.umd.js",
"module": "dist/index.mjs",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 1dab147

Please sign in to comment.