Skip to content

Commit

Permalink
fix: update lorem-ipsum dependency (#19)
Browse files Browse the repository at this point in the history
* Update README.md

* Update lorem-ipsum dependency

* Update package.json
  • Loading branch information
Belco90 committed Aug 8, 2023
1 parent 67bc699 commit f198a9f
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 60 deletions.
70 changes: 22 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,51 @@
# 🐘 Mastodonte JS
# 🐘 Mastodonte

Mastodonte JS es un generador de palabras para los mastodontes, cracks y figuras como tú.
`mastodonte` es un generador de palabras para los mastodontes, cracks y figuras como tú.

<img src="https://i.imgur.com/5BEM3oA.gif" />

Esta librería es simplemente un lorem ipsum pero usando las palabras adecuadas para los máquinas, genios y artistas. De hecho, Mastodonte JS está construido sobre [lorem-ipsum.js](https://github.com/knicklabs/lorem-ipsum.js), así que puedes leer su documentación para saber más sobre las opciones disponibles.
Esta librería es simplemente un lorem ipsum pero usando las palabras adecuadas para los máquinas, genios y artistas. De hecho, `mastodonte` está construido sobre [lorem-ipsum.js](https://github.com/knicklabs/lorem-ipsum.js), así que puedes leer su documentación para saber más sobre las opciones disponibles.

## Instalación

**npm**
**pnpm**

```shell
pnpm add -D mastodonte
```
npm install mastodonte

**npm**

```shell
npm install -D mastodonte
```

**yarn**

```
yarn add mastodonte
```shell
yarn add -D mastodonte
```

## Usando la clase Mastodonte (recomendada)

```
import { Mastodonte } from "mastodonte";
// const Mastodonte = require("mastodonte").Mastodonte;
```js
import { Mastodonte } from 'mastodonte'

const mastodonteIpsum = new Mastodonte();
const mastodonteIpsum = new Mastodonte()

mastodonteIpsum.generateWords(1);
mastodonteIpsum.generateSentences(5);
mastodonteIpsum.generateParagraphs(7);
mastodonteIpsum.generateWords(1)
mastodonteIpsum.generateSentences(5)
mastodonteIpsum.generateParagraphs(7)
```

> Recuerda que puedes usar las mismas opciones disponibles en [lorem-ipsum](https://github.com/knicklabs/lorem-ipsum.js#using-the-class)
## Usando la función mastodonte

```
import { mastodonte } from "mastodonte";
// const mastodonte = require("mastodonte").mastodonte;
```js
import { mastodonte } from 'mastodonte'

mastodonte(); // genera una frase por defecto
mastodonte() // genera una frase por defecto
```

> Recuerda que puedes usar las mismas opciones disponibles en [lorem-ipsum](https://github.com/knicklabs/lorem-ipsum.js#using-the-function)
---

## TSDX Bootstrap

This project was bootstrapped with [TSDX](https://github.com/jaredpalmer/tsdx).

## Local Development

Below is a list of commands you will probably find useful.

### `npm start` or `yarn start`

Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab.

<img src="https://user-images.githubusercontent.com/4060187/52168303-574d3a00-26f6-11e9-9f3b-71dbec9ebfcb.gif" width="600" />

Your library will be rebuilt if you make edits.

### `npm run build` or `yarn build`

Bundles the package to the `dist` folder.
The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

<img src="https://user-images.githubusercontent.com/4060187/52168322-a98e5b00-26f6-11e9-8cf6-222d716b75ef.gif" width="600" />

### `npm test` or `yarn test`

Runs the test watcher (Jest) in an interactive mode.
By default, runs tests related to files changed since the last commit.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mastodonte",
"version": "0.0.0-semantically-released",
"description": "🐘 Mastodonte JS - un generador de palabras para los mastodontes, cracks y figuras como tú.",
"description": "🐘 mastodonte - un generador de palabras para los mastodontes, cracks y figuras como tú.",
"type": "module",
"scripts": {
"build": "tsup",
Expand All @@ -20,7 +20,7 @@
"semantic-release": "semantic-release"
},
"dependencies": {
"lorem-ipsum": "^2.0.3"
"lorem-ipsum": "^2.0.8"
},
"devDependencies": {
"@swc/core": "^1.3.74",
Expand Down Expand Up @@ -84,6 +84,6 @@
},
"homepage": "https://github.com/Belco90/mastodonte-js",
"bugs": {
"url": "https://github.com/testing-library/eslint-plugin-testing-library/issues"
"url": "https://github.com/Belco90/mastodonte-js/issues"
}
}
19 changes: 10 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f198a9f

Please sign in to comment.