# homestars-icons

> HomeStars componentized icons

Latest version **0.1.62** (published 2020-11-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install homestars-icons
pnpm add homestars-icons
yarn add homestars-icons
bun add homestars-icons
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.62 |
| Published | 2020-11-02 |
| First published | 2018-01-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 429.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Benjamin Bruneau |
| Maintainers | debug01, ebsmoove, splinter7 |
| Keywords | HomeStars, React, Icons, SVG |

## Links

- npm: https://www.npmjs.com/package/homestars-icons
- Repository: https://github.com/homestars/icons
- Homepage: https://github.com/homestars/icons#readme
- Issues: https://github.com/homestars/icons/issues
- npm.io page: https://npm.io/package/homestars-icons

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^16.5.2
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.1.62 (latest) — 2020-11-02
- 0.1.60 — 2020-09-10
- 0.1.58 — 2020-09-10
- 0.1.54 — 2020-08-19
- 0.1.53 — 2020-08-19
- 0.1.52 — 2020-08-19
- 0.1.51 — 2020-08-18
- 0.1.49 — 2020-04-22
- 0.1.48 — 2020-03-25
- 0.1.47 — 2020-03-24
- 0.1.46 — 2020-03-23
- 0.1.45 — 2020-02-19
- 0.1.44 — 2020-02-11
- 0.1.43 — 2020-02-04
- 0.1.42 — 2020-01-23
- … 42 more at https://npm.io/package/homestars-icons/versions

## README

# HomeStars Componentized Icons

A set of React components containing SVG icons. [View all currently available icons](https://stackblitz.com/edit/homestars-icons-example)

## Installation

Using npm:
```shell
$ npm i --save homestars-icons
```

## Usage

1. Import an icon into your app.

```js
import { Project } from "homestars-icons";
```

2. Most colour options can be specified via the `stroke` prop:

```js
render = () => {
  return <Project stroke="#000000" />;
}
```

Some icons can accept a `fill` value as well; some have even more robust colouring options.

```js
<Lock 
  stroke="LightSteelBlue"
  fill="Goldenrod"
  keyholeFill="DarkSlateGrey"
/>
```

The default in most cases is `#000000`; notable exceptions include logo icons.

3. The default size is 22px x 22px, but can be adjusted via the `size` prop.

## Contributing

1. Clone this project

```shell
$ git clone git@github.com:homestars/icons.git
```

2. Install dependencies

```shell
$ npm install
```

3. Start the dev environment

```shell
$ npm start
```
## Publishing
1. To publish one must have an npm account and be added to the to the [https://www.npmjs.com/org/homestarsdotcom](Homestarsdotcom) team.

2. Additionaly, one has to login into npm from the command line
```shell
npm login
```

3. Finally, after committing changes to `master`, run following command to publish to npm: 

```shell
$ npm run patch
```

This will increment the version, build a distribution, and publish to NPM.

4. Finally, update the npm version of the homestars-icon package in the package.json of your project. 
```shell
npm upgrade homestars-icons
```

---
_Source: https://npm.io/package/homestars-icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._