Skip to content

Commit

Permalink
Merge pull request #5 from manifoldco/dangodev/wrench
Browse files Browse the repository at this point in the history
Add wrench
  • Loading branch information
DangoDev authored Feb 6, 2020
2 parents c6cfb18 + 4475321 commit a67346e
Show file tree
Hide file tree
Showing 7 changed files with 3,303 additions and 1,783 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: pull_request

on: [pull_request]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
- run: npm install
- run: npm run build
2 changes: 0 additions & 2 deletions .manifold.yml.example

This file was deleted.

11 changes: 0 additions & 11 deletions .travis.yml

This file was deleted.

27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,39 @@ Manifold’s icon system
## Setup

```bash
npm i
cp .manifold.yml.example .manifold.yml
npm install
```

This will work out-of-box, but edit `.manifold.yml` if necessary (separate
file allows changes without accidentally committing and breaking things for
others).

## Usage

```bash
npm i @manifoldco/icons
```

```ts
```jsx
import { arrow_right } from '@manifoldco/icons';

const Icon = () => (
<svg
viewBox="0 0 1024 1024"
xmlns="http://www.w3.org/2000/svg"
xmlnsX="http://www.w3.org/1999/xlink"
>
<path d={arrow_right} />
</svg>
);
```

_Note: the `viewBox="0 0 1024 1024"` is the most important part!_

## Publishing to npm

You must be logged into npm and have access to the `@manifoldco` team to publish.

```bash
npm run publish
npm run deploy
```

_Note: this is **different** from `npm publish`!_

Other repos use Git tagging, but this is a little different. We’re using
@pika/pack’s npm publish script, which is a command prompt UI. For that reason,
publishing happens locally.
Expand Down
Loading

0 comments on commit a67346e

Please sign in to comment.