		# sigil-js

		[![Version](https://img.shields.io/npm/v/urbit-sigil-js.svg)](https://www.npmjs.com/package/@tlon/sigil-js)
		![Minzipped Size](https://img.shields.io/bundlephobia/minzip/@tlon/sigil-js.svg)
		[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
		[![npm (scoped)](https://img.shields.io/npm/v/@tlon/sigil-js?style=flat)](https://www.npmjs.com/package/@tlon/sigil-js)

		[→ Github](https://github.com/urbit/sigil-js)

		[→ NPM](https://www.npmjs.com/package/@tlon/sigil-js)
		Each of the ~4.2 billion points on Azimuth is unique. Each one has a pronounceable, easily memorized name, something like ~ravmel-ropdyl. Sigils visualize these names – there are as many unique Sigils as there are Azimuth points. `@tlon/sigil-js` is a javascript library that converts one of these names into its corresponding Sigil.

		Each of the ~4.2 billion points on Azimuth is unique. Each one has a pronounceable, easily memorized name, something like ~ravmel-ropdyl. Sigils visualize these names – there are as many unique Sigils as there are Azimuth points. `sigil-js` is a javascript library that converts one of these names into its corresponding Sigil.
		![sigil intro image](https://github.com/urbit/sigil-js/blob/master/docs/intro.png?raw=true)

		![example images](https://github.com/urbit/sigil-js/blob/master/docs/a.png?raw=true)
		## Basic Usage

		## Usage


		### ES2015 / React
		### React
		```js
		import { sigil, reactRenderer } from 'urbit-sigil-js'
		import { sigil, reactRenderer } from '@tlon/sigil-js'

		const Sigil = props => {
		return (
		<div>
		<>
		{
		@@ -33,3 +29,3 @@ sigil({
		}
		</div>
		</>
		)
		@@ -39,22 +35,8 @@ }

		### Node
		```js
		const { sigil, stringRenderer } = require('urbit-sigil-js')
		[More examples...](https://github.com/urbit/sigil-js/blob/master/preview/src/pages/Home.tsx)

		const svgString = sigil({
		patp: 'zod',
		renderer: stringRenderer,
		size: 128,
		colors: ['black', 'white'],
		})

		```


		## Install

		SSH: `npm install git+ssh://git@github.com/urbit/sigil-js`
		`npm install @tlon/sigil-js`

		HTTPS: `npm install git+https://git@github.com/urbit/sigil-js`

		## API
		@@ -67,6 +49,8 @@
		\|`size`\| Width and height of desired SVG output\| `integer`\| No \|
		\|`width`\| Width of desired SVG output\| `integer`\| No \|
		\|`height`\| Height of desired SVG output\| `integer`\| No \|
		\|`colors`\| A background (first value) and foreground color (second value) with which to paint the sigil\| `array` like `[#4330FC, #FFFFFF]`\| Yes, default is ['#000', '#fff']
		\|`margin`\| Should the layout use margin or not? \| `boolean` \| Yes
		\|`class`\| CSS class to add to the outer SVG tag\| `string` \| Yes
		\|`attributes`\| Adds DOM tag attributes to the outer SVG element\| `object` \| Yes
		\|`attributes`\| Adds DOM tag attributes to the outer SVG element, like width and height\| `object` \| Yes

		@@ -80,14 +64,2 @@ ### About the `renderer` param

		## Development
		These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

		### Prerequisites
		You'll need Node installed. We use 10.0.0. To install Node on MacOS or Ubuntu, look [here](https://nodesource.com/blog/installing-node-js-tutorial-using-nvm-on-mac-os-x-and-ubuntu/). Once you have Node, you'll need to clone this repository.

		SSH: `git@github.com:urbit/sigil-js.git`

		HTTPS: `https://github.com/urbit/sigil-js.git`

		Then, `cd` into the repository and run `npm install`.

		### Build
		@@ -124,2 +96,2 @@

		![many](https://github.com/urbit/sigil-js/blob/master/docs/outro.png?raw=true)
		![sigil outro image](https://github.com/urbit/sigil-js/blob/master/docs/outro.png?raw=true)

@tlon/sigil-js - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics