odd-trimer

Table of Contents

• About
• Getting Started
• Usage
• Contributing

About

Creates summeries from long sentences

Getting Started

import the package and simply use

import oddTrimmer from 'odd-trimmer';

const newSentence =
  'This is an example string to be summerized and cut into ten pieces by the trimmer';
const summerizedSentence = oddTrimmer(newSentence, 'short');
consoloe.log(summerizedSentence); // This is an example string to be summerized and cut...

Prerequisites

What things you need to install the software and how to install them.

npm  or yarn

node

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

npm install odd-trimmer

With Yarn

yarn add odd-trimmer

End with an example of getting some data out of the system or using it for a little demo.

Usage

import the package and simply use

import oddTrimmer from 'odd-trimmer';

const newSentence =
  'This is an example string to be summerized and cut into ten pieces by the trimmer';
const summerizedSentence = oddTrimmer(newSentence, 'short');
consoloe.log(summerizedSentence); // This is an example string to be summerized and cut...