Skip to content

Commit

Permalink
updates documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
davelandry committed Jan 4, 2023
1 parent c8ad115 commit 8c91306
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# d3plus-text

[![NPM Release](http://img.shields.io/npm/v/d3plus-text.svg?style=flat)](https://www.npmjs.org/package/d3plus-text) [![Build Status](https://travis-ci.org/d3plus/d3plus-text.svg?branch=master)](https://travis-ci.org/d3plus/d3plus-text) [![Dependency Status](http://img.shields.io/david/d3plus/d3plus-text.svg?style=flat)](https://david-dm.org/d3plus/d3plus-text) [![Gitter](https://img.shields.io/badge/-chat_on_gitter-brightgreen.svg?style=flat&logo=gitter-white)](https://gitter.im/d3plus/)

A smart SVG text box with line wrapping and automatic font size scaling.

## Installing

If you use NPM, `npm install d3plus-text`. Otherwise, download the [latest release](https://github.com/d3plus/d3plus-text/releases/latest). You can also load d3plus-text as a standalone library or as part of [D3plus](https://github.com/d3plus/d3plus). ES modules, AMD, CommonJS, and vanilla environments are supported. In vanilla, a `d3plus` global is exported:
If using npm, `npm install d3plus-text`. Otherwise, you can download the [latest release from GitHub](https://github.com/d3plus/d3plus-text/releases/latest) or load from a [CDN](https://cdn.jsdelivr.net/npm/d3plus-text@1).

```js
import modules from "d3plus-text";
```

d3plus-text can be loaded as a standalone library or bundled as part of [D3plus](https://github.com/d3plus/d3plus). ES modules, AMD, CommonJS, and vanilla environments are supported. In vanilla, a `d3plus` global is exported:

```html
<script src="https://cdn.jsdelivr.net/npm/d3plus-text@1"></script>
Expand All @@ -15,6 +19,10 @@ If you use NPM, `npm install d3plus-text`. Otherwise, download the [latest relea
</script>
```

## Examples

Live examples can be found on [d3plus.org](https://d3plus.org/), which includes a collection of example visualizations using [d3plus-react](https://github.com/d3plus/d3plus-react/). These examples are powered by the [d3plus-storybook](https://github.com/d3plus/d3plus-storybook/) repo, and PRs are always welcome. :beers:

## API Reference

#####
Expand Down Expand Up @@ -633,4 +641,4 @@ This is a global function.



###### <sub>Documentation generated on Wed, 06 Jul 2022 21:46:02 GMT</sub>
###### <sub>Documentation generated on Wed, 04 Jan 2023 23:07:33 GMT</sub>

0 comments on commit 8c91306

Please sign in to comment.