1 | # LSK.js – Image
|
2 |
|
3 | > React component for images
|
4 |
|
5 | [![LSK logo](https://badgen.net/badge/icon/MADE%20BY%20LSK?icon=zeit&label&color=red&labelColor=red)](https://github.com/lskjs)
|
6 | [![NPM version](https://badgen.net/npm/v/@lskjs/image)](https://www.npmjs.com/package/@lskjs/image)
|
7 | [![NPM downloads](https://badgen.net/npm/dt/@lskjs/image)](https://www.npmjs.com/package/@lskjs/image)
|
8 | [![NPM Dependency count](https://badgen.net/bundlephobia/dependency-count/@lskjs/image)](https://bundlephobia.com/result?p=@lskjs/image)
|
9 | [![Have TypeScript types](https://badgen.net/npm/types/@lskjs/image)](https://www.npmjs.com/package/@lskjs/image)
|
10 | [![Have tree shaking](https://badgen.net/bundlephobia/tree-shaking/@lskjs/image)](https://bundlephobia.com/result?p=@lskjs/image)
|
11 | [![NPM Package size](https://badgen.net/bundlephobia/minzip/@lskjs/image)](https://bundlephobia.com/result?p=@lskjs/image)
|
12 | [![Package size](https://badgen.net//github/license/lskjs/lskjs)](https://github.com/lskjs/lskjs/blob/master/LICENSE)
|
13 | [![Ask us in Telegram](https://img.shields.io/badge/Ask%20us%20in-Telegram-brightblue.svg)](https://t.me/lskjschat)
|
14 |
|
15 |
|
16 | ## Installation and usage
|
17 |
|
18 | The easiest way to use is to install it from npm and build it into your app with Webpack.
|
19 |
|
20 | ```bash
|
21 | npm install @lskjs/image
|
22 | ```
|
23 |
|
24 | Then use it in your app:
|
25 |
|
26 | ```jsx
|
27 | import Image from '@lskjs/image';
|
28 |
|
29 | const App = (
|
30 | <Image src="primary" />
|
31 | );
|
32 | ```
|
33 |
|
34 | ## Contributors ✨
|
35 |
|
36 |
|
37 |
|
38 |
|
39 | <table>
|
40 | <tr>
|
41 | <td align="center"><a href="https://isuvorov.com"><img src="https://avatars2.githubusercontent.com/u/1056977?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Igor Suvorov</b></sub></a><br /><a href="lskjs/lskjs///commits?author=isuvorov" title="Code">💻</a> <a href="#design-isuvorov" title="Design">🎨</a> <a href="#ideas-isuvorov" title="Ideas, Planning, & Feedback">🤔</a></td>
|
42 | </tr>
|
43 | </table>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 | ## License
|
51 | This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
|
52 |
|
53 | ## Contributing
|
54 | 1. Fork it (<https://github.com/yourname/yourproject/fork>)
|
55 | 2. Create your feature branch (`git checkout -b features/fooBar`)
|
56 | 3. Commit your changes (`git commit -am 'feat(image): Add some fooBar'`)
|
57 | 4. Push to the branch (`git push origin feature/fooBar`)
|
58 | 5. Create a new Pull Request
|
59 |
|
60 | ## Any questions? Always welcome :)
|
61 | - [Email](mailto:hi@isuvorov.com)
|
62 | - [LSK.news – Telegram channel](https://t.me/lskjs)
|
63 | - [Спроси нас в телеграме ;)](https://t.me/lskjschat) |
\ | No newline at end of file |