Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pleshevskiy committed Aug 15, 2021
1 parent 9aeeb2e commit d6b0f0b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@

# npm-rusn
# rusn

[![Build Status](https://travis-ci.org/icetemple/npm-rusn.svg?branch=master)](https://travis-ci.org/icetemple/npm-rusn)
[![ci](https://github.com/icetemple/npm-rusn/actions/workflows/ci.yml/badge.svg)](https://github.com/icetemple/npm-rusn/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/icetemple/npm-rusn/badge.svg)](https://coveralls.io/github/icetemple/npm-rusn)

Portable from python package small library for getting russian text with singular and plural forms
Small library without deps for getting russian text with singular and plural forms

## Installation

`npm install rusn`


## Example
## Usage

```js
const appleForms = ['яблоко', 'яблока', 'яблок']
import { rusPluralize } from "rusn";

console.log(rusNGetText(1, appleForms)) // яблоко
const appleForms = ["яблоко", "яблока", "яблок"];

console.log(rusNGetText(10, appleForms)) // яблок
console.log(rusPluralize(1, appleForms)); // яблоко

console.log(rusPluralize(10, appleForms)); // яблок
```
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "rusn",
"version": "1.0.5",
"description": "Portable from python package small library for getting russian text with singular and plural forms",
"version": "1.1.0",
"description": "Small library without deps for getting russian text with singular and plural forms",
"type": "module",
"main": "./rusn.mjs",
"types": "./rusn.d.ts",
Expand Down

0 comments on commit d6b0f0b

Please sign in to comment.