# symbol-ipsum

> this is a module to generate words that include special characters (symbols and character entities) based on utf-8 encoding.

Latest version **0.0.2** (published 2016-03-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install symbol-ipsum
pnpm add symbol-ipsum
yarn add symbol-ipsum
bun add symbol-ipsum
```

## 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.0.2 |
| Published | 2016-03-11 |
| First published | 2015-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Natasha Dykes |
| Maintainers | sashak007 |

## Links

- npm: https://www.npmjs.com/package/symbol-ipsum
- Repository: https://github.com/sashak007/symbolIpsum
- Homepage: https://github.com/sashak007/symbolIpsum#readme
- Issues: https://github.com/sashak007/symbolIpsum/issues
- npm.io page: https://npm.io/package/symbol-ipsum

## Recent versions

- 0.0.2 (latest) — 2016-03-11
- 0.0.1 — 2015-08-21

## README

# symbolIpsum

[![Build Status](https://travis-ci.org/sashak007/symbolIpsum.svg)](https://travis-ci.org/sashak007/symbolIpsum)

[![Coverage Status](https://coveralls.io/repos/sashak007/symbolIpsum/badge.svg?branch=master&service=github)](https://coveralls.io/github/sashak007/symbolIpsum?branch=master)

## Synopsis
Symbol Ipsum is a text generator that handles utf-8 characters, including accented and special character. I've included two word lists: rendered accented characters and symbols as well as entity encoded characters. 

## Usage

### Node.js
```
var symbolIpsum = require('symbolIpsum');

var  text = symbolIpsum.words(6,'symbols'); // atkvæði, d’état, ¿cómo?, benåde, fußgängerübergänge, Σ
var sentence = symbolIpsum.sentences(7,14,2,'entities'); // outputs two sentences between seven to 14 words each with the entity encoding.
var paragraph  = symbolIpsum.paragraphs(7,14,5,3,'symbols'); // outputs three paragraphs with five sentences between seven to 14 words each with rendered symbols.
```

## Motivation

There's some great text generator packages out there but I've found that they only provide ASCII alphanumeric values. For testing purposes this isn't ideal and there's a need for more comprehensive data, my goal with this module is to provide dummy data with accented character and other special characters specific to unicode.  

## Installation 	

`npm install symbol-ipsum`

## Tests

`npm test`

## License

symbolIpsum copyright (c) 2015 Natasha Dykes

This software is hereby granted, free of charge, to any person interested. Software is 'AS IS', I absolve any liability for damages.

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