parsec - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

package.json

 {
   "name": "parsec",
-  "version": "2.0.0",
-  "description": "",
+  "version": "2.0.1",
+  "description": "A duration parser and formatter to turn random garbage into program usable times.",
   "main": "index.js",
@@ -11,11 +11,11 @@ "scripts": {
     "type": "git",
-    "url": "git+https://github.com/npm/deprecate-holder.git"
+    "url": "git+https://github.com/fatalcenturion/parsec.git"
   },
+  "keywords": [],
   "author": "",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/npm/deprecate-holder/issues"
+    "url": "https://github.com/fatalcenturion/parsec/issues"
   },
-  "homepage": "https://github.com/npm/deprecate-holder#readme",
-  "dependencies": {}
+  "homepage": "https://github.com/fatalcenturion/parsec#readme"
 }

README.md

@@ -1,5 +0,139 @@
-# Deprecated Package
+# ParSec
+## A duration parser and formatter to turn random garbage into program usable times.<br>
+## Provides a clear, easy to use interface to parse strings into usable timings<br>
+Example:
+```js
+Parsec('aug3 1920').format('{MONTH-NAME} {DAYS}{DAY-SUFFIX} {YEAR}') 
+// August 3rd 1920
+```
+----
+## Documentation Navigation
++ [Installation](https://github.com/fatalcenturion/parsec#installation)
+    - [NPM](https://github.com/fatalcenturion/parsec#npm)
+    - [Yarn](https://github.com/fatalcenturion/parsec#yarn)
 
-This package is no longer supported and has been deprecated. To avoid malicious use, npm is hanging on to the package name.
++ [Locales](https://github.com/fatalcenturion/parsec#locales)
+    - [Supported](https://github.com/fatalcenturion/parsec#supported-locales)
+    - [Planned](https://github.com/fatalcenturion/parsec#planned-locales)
 
-Please contact [e-mail] if you have questions about this package. 
++ [Usage](https://github.com/fatalcenturion/parsec#usage)
+    - [ParSec](https://github.com/fatalcenturion/parsec#parsec)
+    - [TimeConstruct](https://github.com/fatalcenturion/parsec#timeconstruct)
+----
+## Installation
+### NPM
+Installing on NPM is simple, just open your terminal and run:
+```
+npm install parsec --save
+```
+### Yarn
+to install with Yarn, open your terminal and use:
+```
+yarn add parsec
+```
+----
+## Locales
+### Supported Locales
+All languages supported by this module are translated to the best knowledge of the person submitting the translation, this means we are trying to get native speakers of the language to submit translations of time phrases in their local language,
+|Language|Native|Supported Since|Translator|
+|:------:|:----:|:-------------:|:--------:|
+|English|English|0.0.1|Fatalcenturion|
+
+### Planned Locales
+This table contains languages which we are planning to implement into the module, but have not managed to do just yet.
+If you are a native speaker of any of the languages below and would like to help translate, please get in touch so we can send you a translation package.
+
+|Language|Native|
+|:------:|:----:|
+|German|Deutsch|
+|French| français|
+|Spanish|español|
+|Portuguese|português|
+
+### Suggest a Locale
+To suggest a Locale for ParSec, please open an issue and use the "Locale" tag informing us of the locale you wish to add
+----
+## Usage
+
+## ParSec
+Importing the module:
+
+```js
+const ParSec = require('parsec');
+```
+
+Getting started:
+
+This module is a hybrid function-object, this means that the module can be called by running both:
+```js
+let parsed = ParSec('1 minute, 30 seconds and 145 milliseconds');
+```
+And:
+```js
+let parsed = ParSec.parse('1 minute, 30 seconds and 145 milliseconds');
+```
+> Note: in both cases here, ``parsed`` is an instance of ``TimeConstruct``.<br>
+> ``TimeConstruct`` is a custom class built to provide detailed information about your parsed results.<br>
+> [Read the documentation on ``TimeConstruct`` for more information](https://github.com/fatalcenturion/parsec#timeconstruct)
+
+Values:
+> 
+
+
+> `self`:<br>
+> > Parameters:<br>
+> > inputString: `String`<br><br>
+> > Description: Formats the provided string into an instance of `TimeConstruct`.<br><br>
+> > Usage: 
+```js
+ParSec(<inputString>)
+```
+
+<br>
+
+> `format`:<br>
+> > Parameters<br>
+> > inputString: `String`<br><br>
+> > Description:<br>
+> > Formats the provided string using internal values
+> > (Internal version of ParSec(string))
+
+> `parse`:<br>
+> > Parameters<br>
+> > inputString: `String`<br><br>
+> > Description:<br>
+> > Formats the provided string into an instance of `TimeConstruct`
+> > (Internal version of ParSec(string))
+
+----
+
+## TimeConstruct
+Layout:
+
+Values:
+> locale: `String`<br>
+> milliseconds: `Number`<br>
+> seconds: `Number`<br>
+> minutes: `Number`<br>
+> hours: `Number`<br>
+> days: `Number`<br>
+> weeks: `Number`<br>
+> months: `Number`<br>
+> years: `Number`<br>
+
+Methods:
+> `format`:<br>
+> > Parameters<br>
+> > inputString: `String`<br><br>
+> > Description:<br>
+> > Formats the provided string using internal values
+> > (Internal version of ParSec(string))
+
+> `into`:<br>
+> > Parameters<br>
+> > inputString: `String`<br><br>
+> > Description:<br>
+> > Formats the provided string, converting all internal values to the largest specified value
+> > (Internal version of ParSec(string))
+
+### More coming soon....

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12682

increased by1735.31%

Number of package files

12

increased by500%

Lines of code

187

increased byInfinity%

Number of lines in readme file

139

increased by2216.67%

Number of medium supply chain risk alerts

1

decreased by-66.67%

Worsened metrics

Number of low maintenance alerts

2

increased by100%

Number of low quality alerts

2

increased by100%

No dependency changes