diff --git a/README.md b/README.md index 062a7c8..ef08780 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ For a type to be compatible with the algorithm: - `` MUST consist of one or more characters, and SHOULD equal the name of the npm package which defines the - type (including [scope][4] where appropriate); + type (including [scope][3] where appropriate); - `` MUST consist of one or more characters, and SHOULD be the unique name of the type; and @@ -92,10 +92,10 @@ const type = require('sanctuary-type-identifiers'); ### API -

type :: Any -> String

+

type :: Any -> String

Takes any value and returns a string which identifies its type. If the -value conforms to the [specification][3], the custom type identifier is +value conforms to the [specification][4], the custom type identifier is returned. ```javascript @@ -109,9 +109,9 @@ returned. 'my-package/Identity@1' ``` -

type.parse :: String -> { namespace :: Nullable String, name :: String, version :: Number }

+

type.parse :: String -> { namespace :: Nullable String, name :: String, version :: Number }

-Takes any string and parses it according to the [specification][3], +Takes any string and parses it according to the [specification][4], returning an object with `namespace`, `name`, and `version` fields. ```javascript @@ -127,5 +127,5 @@ returning an object with `namespace`, `name`, and `version` fields. [1]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof [2]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toString -[3]: #specification -[4]: https://docs.npmjs.com/misc/scope +[3]: https://docs.npmjs.com/misc/scope +[4]: #specification diff --git a/package.json b/package.json index 648f837..2d97fdf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sanctuary-type-identifiers", - "version": "2.0.0", + "version": "2.0.1", "description": "Specification for type identifiers", "license": "MIT", "repository": {