plain-ole-resume

For quickly and easily creating plain text resumes.

Usage no npm install needed!

<script type="module">
  import plainOleResume from 'https://cdn.skypack.dev/plain-ole-resume';
</script>

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)

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');