agerix/iconify
2
0
Fork 0
mirror of https://github.com/iconify/iconify.git synced 2025-01-23 07:08:34 +00:00
Code Issues Releases Activity

Swap order of web component and legacy components in readme

Browse Source
This commit is contained in:
Vjacheslav Trushkin 2022-05-14 08:32:50 +03:00
parent c448199ec6
commit 9e87cca3da
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -48,9 +48,25 @@ Main packages:
- [Iconify types](./packages/types/) - TypeScript types. - [Iconify types](./packages/types/) - TypeScript types.
- [Iconify utils](./packages/utils/) - common files used by various Iconify projects (including tools, API, etc...). - [Iconify utils](./packages/utils/) - common files used by various Iconify projects (including tools, API, etc...).
- [Iconify core](./packages/core/) - common files used by various components. - [Iconify core](./packages/core/) - common files used by various icon components.
- [API redundancy](./packages/api-redundancy/) - library for managing redundancies for loading data from API: handling timeouts, rotating hosts. - [API redundancy](./packages/api-redundancy/) - library for managing redundancies for loading data from API: handling timeouts, rotating hosts.
### Web component
Directory `iconify-icon` contains `iconify-icon` web component and wrappers for various frameworks.
| Package | Usage |
| -------------------------------------- | ---------- |
| [Web component](./iconify-icon/icon/) | Everywhere |
| [React wrapper](./iconify-icon/react/) | React |
#### Demo
Directory `iconify-icon-demo` contains demo packages that show usage of `iconify-icon` web component.
- [Ember demo](./iconify-icon-demo/ember-icon-demo/) - demo using web component with Ember. Run `npm run build` to build demo and `npm run start` to start it.
- [React demo](./iconify-icon-demo/react-demo/) - demo using web component with React. Run `npm run dev` to start demo.
### Iconify icon components ### Iconify icon components
Directory `components` contains Iconify icon components and SVG framework. Directory `components` contains Iconify icon components and SVG framework.
@ -97,22 +113,6 @@ Directory `components-demo` contains demo packages that show usage of icon compo
- [SvelteKit demo](./components-demo/sveltekit-demo/) - demo for SvelteKit, using Svelte component on the server and in the browser. Run `npm run dev` to start the demo. - [SvelteKit demo](./components-demo/sveltekit-demo/) - demo for SvelteKit, using Svelte component on the server and in the browser. Run `npm run dev` to start the demo.
- [Ember demo](./components-demo/ember-demo/) - demo for Ember component. Run `npm run build` to build demo and `npm run start` to start it. - [Ember demo](./components-demo/ember-demo/) - demo for Ember component. Run `npm run build` to build demo and `npm run start` to start it.
### IconifyIcon
Directory `iconify-icon` contains `iconify-icon` web component and wrappers for various frameworks.
| Package | Usage |
| -------------------------------------- | ---------- |
| [Web component](./iconify-icon/icon/) | Everywhere |
| [React wrapper](./iconify-icon/react/) | React |
#### Demo
Directory `iconify-icon-demo` contains demo packages that show usage of `iconify-icon` web component.
- [Ember demo](./iconify-icon-demo/ember-icon-demo/) - demo using web component with Ember. Run `npm run build` to build demo and `npm run start` to start it.
- [React demo](./iconify-icon-demo/react-demo/) - demo using web component with React. Run `npm run dev` to start demo.
## Installation ## Installation
This monorepo used Lerna to manage packages, but due to several bugs in Lerna and Lerna development being abandoned, it was replaced with custom manager. This monorepo used Lerna to manage packages, but due to several bugs in Lerna and Lerna development being abandoned, it was replaced with custom manager.