# plain-ole-resume

> For quickly and easily creating plain text resumes.

Latest version **1.0.4** (published 2015-04-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install plain-ole-resume
pnpm add plain-ole-resume
yarn add plain-ole-resume
bun add plain-ole-resume
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2015-04-23 |
| First published | 2015-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Alexander Eby |
| Maintainers | abeelxy |
| Keywords | resume, plaintext |

## Links

- npm: https://www.npmjs.com/package/plain-ole-resume
- Repository: https://github.com/abeelxy/PlainOleResume
- Issues: https://github.com/abeelxy/PlainOleResume/issues
- npm.io page: https://npm.io/package/plain-ole-resume

## Dependencies (1)

- [fs](https://npm.io/package/fs.md) 0.0.2

## Recent versions

- 1.0.4 (latest) — 2015-04-23
- 1.0.3 — 2015-04-22
- 1.0.2 — 2015-04-22
- 1.0.1 — 2015-04-21
- 1.0.0 — 2015-04-19

## README

# PlainOleResume
For quickly and easily creating plain text resumes.  

## Installation
The npm package name is plain-ole-resume.  

To install:
`npm install plain-ole-resume`

## Usage
Begin by requiring `plain-ole-resume` if using npm and `{path}/PORe.js` (for examples it will be named `pore`) and calling `pore.beginResume()`.  
This method accepts an optional object which contains options for overloading the system. The default options
can be viewed within the prototype `PORe.prototype` within `PORe.js`. The returned object is the resume object
which is used for all building methods.  


For the below examples `resume` is the object returned by calling `pore.beginResume()`  
Note that the order in which commands are called **determines the order when built**.

* Adding a section is done by calling `resume.addSection(parentId, label)`
 * `parentId` accepts either an id returned by adding a resume element (sections, info pairs, etc) or null for a root element.  
 * `label` accepts a label for the section (Such as `Contact info`, `Education`, etc).

* Adding an info pair is done by calling `resume.addInfoPair(parentId, label, value)`
 * `parentId` accepts either an id returned by adding a resume element (sections, info pairs, etc) or null for a root element.  
 * `label` accepts a string meant to describe the value (Such as `Name`, `Email`, etc).
 * `value` accepts a string of information that should be associated with the given label.

* Multiple info pairs can be added at once by calling `resume.addInfoPairArray(parentId, pairs)`
 * `parentId` accepts either an id returned by adding a resume element or null for a root element.
 * `pairs` accepts an Array of Arrays with the `label` at index 0 and `value` at index 1.

* Adding a plain text line is done by calling `resume.addText(parentId, value, [options])`
 * `parentId` accepts either an id returned by adding a resume element (sections, info pairs, etc) or null for a root element.  
 * `value` accepts a string with the text that should be displayed.
 * `options` [*optional*] accepts an object containing key-value pairs to override the display style of the text, such as `centered`: `true`

* Adding multiple plain text lines is done by calling `resume.addTextArray(parentId, values, [options])`
 * `parentId` accepts either an id returned by adding a resume element or null for a root element.
 * `value` accepts an Array of strings with the text that should be displayed.
 * `options` [*optional*] accepts an object containing key-value pairs to override the display style of the text, such as `centered`: `true`

* In order to complete the building of the resume `resume.build(filename)` is called.
 * `filename` accepts a string containing the filename / path where the resume should be stored. If it exists it will be overwritten.

Example resume (very basic)
```javascript
var pore = require('plain-ole-resume'),

    id,
    resume;

resume = pore.beginResume();

id = resume.addSection('Basic information');
resume.addInfoPair(id, 'Reason', 'Demo resume');
resume.addText(id, 'Just demonstrating basic uses.');

resume.build('DemoResume.txt');
```

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