eledoc - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

package.json

 {
   "name": "eledoc",
   "description": "A dark mode for TypeDoc",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "homepage": "http://typedoc.org/",
@@ -6,0 +6,0 @@ "main": "bin/plugin.js",

README.md

 <p align="center">
-  <a href="https://github.com/pirix-gh/eledoc">
-    <img alt="logo" title="eledoc" src="https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/logo.png" width="300">
+  <a href="https://github.com/pirix-gh/ts-toolbelt">
+    <img alt="logo" title="ts-toolbelt" src="https://raw.githubusercontent.com/pirix-gh/ts-toolbelt/master/.github/logo.png" width="300">
   </a>
 
-  <h3 align="center">eledoc</h3>
+  <h3 align="center">ts-toolbelt</h3>
 
@@ -11,3 +11,3 @@ <p align="center">
     <br>
-    <a href="https://pirix-gh.github.io/eledoc/" target="_blank"><strong>Explore the docs »</strong></a>
+    <a href="https://pirix-gh.github.io/ts-toolbelt/" target="_blank"><strong>Explore the docs »</strong></a>
     <br>
@@ -17,5 +17,7 @@ <br>
     ·
-    <a href="https://github.com/pirix-gh/eledoc/issues/new?template=---bug-report.md">🐞 Report Bug</a>
+    <a href="https://github.com/pirix-gh/ts-toolbelt/issues/new?template=---bug-report.md">🐞 Report Bug</a>
     ·
-    <a href="https://github.com/pirix-gh/eledoc/issues/new?template=---feature-request.md">🍩 Request Feature</a>
+    <a href="https://github.com/pirix-gh/ts-toolbelt/issues/new?template=---feature-request.md">🍩 Request Feature</a>
+    ·
+    <a href="https://github.com/pirix-gh/ts-toolbelt/issues/new?template=---question.md">🤔  Ask Questions</a>
   </p>
@@ -25,13 +27,13 @@ </p>
 <p align="center">
-  <a href="https://gitter.im/eledoc/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link" target="_blank">
-    <img src="https://img.shields.io/gitter/room/eledoc/community.svg">
+  <a href="https://gitter.im/ts-toolbelt/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link" target="_blank">
+    <img src="https://img.shields.io/gitter/room/ts-toolbelt/community.svg">
   </a>
-  <a href="https://www.npmjs.com/package/eledoc" target="_blank">
-    <img src="https://img.shields.io/npm/v/eledoc.svg">
+  <a href="https://www.npmjs.com/package/ts-toolbelt" target="_blank">
+    <img src="https://img.shields.io/npm/v/ts-toolbelt.svg">
   </a>
-  <a href="https://travis-ci.org/pirix-gh/eledoc" target="_blank">
-    <img src="https://img.shields.io/travis/pirix-gh/eledoc.svg">
+  <a href="https://travis-ci.org/pirix-gh/ts-toolbelt" target="_blank">
+    <img src="https://img.shields.io/travis/pirix-gh/ts-toolbelt.svg">
   </a>
   <a href="#">
-    <img src="https://img.shields.io/npm/dm/eledoc.svg">
+    <img src="https://img.shields.io/npm/dm/ts-toolbelt.svg">
   </a>
@@ -42,3 +44,3 @@ <a href="http://makeapullrequest.com" target="_blank">
   <a href="#">
-    <img src="https://img.shields.io/npm/l/eledoc.svg">
+    <img src="https://img.shields.io/npm/l/ts-toolbelt.svg">
   </a>
@@ -50,7 +52,7 @@ </p>
 * [📜 About](#-about)
-* [🎩 Features](#-features)
+* [🍩 Features](#-features)
 * [🏁 Getting started](#-getting-started)
-* [📖 Documentation](#-documentation)
-* [👌 Good to know](#-good-to-know)
-* [➕ Contributing](#-contributing)
+* [📖 Documentation](#-documentation-)
+* [🧠 Good to know](#-good-to-know-)
+* [🎁 Contributing](#-contributing)
 * [👏 Sponsoring issues](#-sponsoring-issues)
@@ -60,7 +62,7 @@ * [💉 Running tests](#-running-tests)
 * [🔮 What's next](#-whats-next)
-* [🙏 Acknowledgments](#-acknowledgments)
+* [🙏 Acknowledgements](#-acknowledgements)
 
 ## 📜 About
 
-**eledoc** is a collection of types that makes TypeScript even **safer**.
+**ts-toolbelt** is a collection of types that makes TypeScript even **safer**.
 It's goal is to improve type correctness while adding a whole new set of
@@ -73,3 +75,3 @@ **features** to TypeScript.
 
-**eledoc** completes TypeScript with a collection of more than **150**
+**ts-toolbelt** completes TypeScript with a collection of more than **150**
 tested types.
@@ -79,24 +81,25 @@
 * This package aims to be the home of all **utility types**
-* To keep reasonable **performance**, so it won't bloat TS
-* And write software that's more type-safe, more **robust**
-* (And bring a whole new set of **features** to TypeScript)
+* High [**performance**](https://gist.github.com/pirix-gh/02097996d2a1e4e7aa2d54b330451ea0), so it will not bloat TS (max +4sec)
+* Computed types are always **readable**, like if you typed it
+* Software that's more type-safe, **flexible** & more **robust**
+* Bring a whole new set of extra **features** to TypeScript
+* Types can be **combined** together to create new ones!
 
-## 🎩 Features
+## 🍩 Features
 
 Here's some of the most useful features:
 
-* [Merge two types together](https://pirix-gh.github.io/eledoc/modules/_object_merge_.html#merge)
-* [Update the field of a type](https://pirix-gh.github.io/eledoc/modules/_object_update_.html#update)
-* [Make some fields optional](https://pirix-gh.github.io/eledoc/modules/_object_optional_.html#optional)
-* [Change a type at any depth!](https://pirix-gh.github.io/eledoc/modules/_object_p_update_.html#update)
-* [Concat two tuples together](https://pirix-gh.github.io/eledoc/modules/_tuple_concat_.html#concat)
-* [Get the last item of a tuple](https://pirix-gh.github.io/eledoc/modules/_tuple_last_.html#last)
+* [Merge two types together](https://pirix-gh.github.io/ts-toolbelt/modules/_object_merge_.html#merge)
+* [Update the field of a type](https://pirix-gh.github.io/ts-toolbelt/modules/_object_update_.html#update)
+* [Make some fields optional](https://pirix-gh.github.io/ts-toolbelt/modules/_object_optional_.html#optional)
+* [Change a type at any depth!](https://pirix-gh.github.io/ts-toolbelt/modules/_object_p_update_.html#update)
+* [Concat two tuples together](https://pirix-gh.github.io/ts-toolbelt/modules/_tuple_concat_.html#concat)
+* [Get the last item of a tuple](https://pirix-gh.github.io/ts-toolbelt/modules/_tuple_last_.html#last)
 * ... and so much more
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/demo.gif" id="demo">
+  <img src="https://raw.githubusercontent.com/pirix-gh/ts-toolbelt/master/.github/demo.gif" id="demo">
 <p align="center">
 
-> If you don't find the type you are looking for, you are welcome to open
-a [feature request](https://github.com/pirix-gh/eledoc/issues/new?template=---feature-request.md)!
+> If you don't find the type you are looking for, you are welcome to open a [feature request](https://github.com/pirix-gh/ts-toolbelt/issues/new?template=---feature-request.md)!
 
@@ -107,2 +110,4 @@ ## 🏁 Getting Started
 
+This is important, the lowest TypeScript version that is [supported](#-compatibility) is 3.5
+
 ```sh
@@ -115,3 +120,3 @@ npm install typescript@^3.5.0 --save
 ```sh
-npm install eledoc --save
+npm install ts-toolbelt --save
 ```
@@ -122,3 +127,4 @@
 ```ts
-import {A, B, C, F, I, N, O, S, T, U} from 'eledoc'
+import {A, B, C, F, I, N, O, S, T, U} from 'ts-toolbelt'
+// Wonder what these letters mean? Check the docs below
 
@@ -129,15 +135,34 @@ // Merge two `object` together
 
-## [📖 Documentation ⤢](https://pirix-gh.github.io/eledoc/)
+## [📖 Documentation ⤢](https://pirix-gh.github.io/ts-toolbelt/)
 
 The project is organized around TypeScript's main concepts:
 
-|                |                |                 |              |             |
-|----------------|----------------|-----------------|--------------|-------------|
-| **A**(ny)      | **C**(lass)    | **I**(teration) | **O**(bject) | **T**(uple) |
-| **B**(boolean) | **F**(unction) | **N**(umber)    | **S**(tring) | **U**(nion) |
+|              |                    |              |                |                 |              |
+|--------------|--------------------|--------------|----------------|-----------------|--------------|
+| **A**(ny)    | **B**(boolean)     | **C**(lass)  | **F**(unction) | **I**(teration) | **N**(umber) |
+| **O**(bject) | **O**(bject).**P** | **S**(tring) | **T**(uple)    | **U**(nion)     | Test         |
 
-```ts
-import {A, B, C, F, I, N, O, S, T, U} from 'eledoc'
-```
+**The documentation is complete but needs more examples**. So feel free to [ask for
+examples](https://github.com/pirix-gh/ts-toolbelt/issues/new?template=---question.md),
+and I will update the docs.
 
+#### Imports
+
+There are many ways to import the types into your project:
+
+* Explicit
+  ```ts
+  import {Any, Boolean, Class, Function, Iteration, Number, Object, String, Tuple, Union} from 'ts-toolbelt'
+  ```
+
+* Compact
+  ```ts
+  import {A, B, C, F, I, N, O, S, T, U} from 'ts-toolbelt'
+  ```
+
+* Portable
+  ```ts
+  import tb from 'ts-toolbelt'
+  ```
+
 #### Internal Docs
@@ -148,4 +173,13 @@
 
-## Good to Know
+## [🧠 Good to Know ⤢](https://github.com/pirix-gh/ts-toolbelt/wiki)
 
+In this wiki, you'll find some extra resources for your learning & understanding.
+
+It is incremental and it will be completed on demand, you can ask for this below.
+
+#### [Questions ⤢](https://github.com/pirix-gh/ts-toolbelt/issues?q=label%3Aquestion+sort%3Areactions-%2B1-desc)
+
+Are you missing something? Participate to the open-wiki by posting your
+questions [right here](https://github.com/pirix-gh/ts-toolbelt/issues/new?template=---question.md).
+
 ## 🎁 Contributing
@@ -158,11 +192,11 @@
 #### Community
-* [Help the community with answers on Gitter](https://gitter.im/eledoc/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
-* [Reporting bugs or requesting new features](https://github.com/pirix-gh/eledoc/issues/new/choose)
+* [Help the community with answers on Gitter](https://gitter.im/ts-toolbelt/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
+* [Reporting bugs or requesting new features](https://github.com/pirix-gh/ts-toolbelt/issues/new/choose)
 
 #### Codebase
 * Improving existing documentation 
-* Add new types to the collection
+* Adding new types to the collection
 
 #### Pull Requests
-1. [Read the tutorial](#https://medium.comfree-code-camptypescript-curry-ramda-types-f747e99744ab)
+1. [Read the tutorial](https://medium.com/free-code-camp/typescript-curry-ramda-types-f747e99744ab)
 2. Fork the project
@@ -178,3 +212,3 @@ 3. Clone your fork
    ```
-6. Run the tests
+6. [Run the tests](#-running-tests)
 7. Commit your changes
@@ -189,7 +223,8 @@ ```sh
 **Sponsored issues have higher priority over non-critical issues**.<br>
+
 You can either request a new feature or a bug fix then fund it.
 
-<a href="https://issuehunt.io/r/pirix-gh/eledoc">
+<a href="https://issuehunt.io/r/pirix-gh/ts-toolbelt">
   <img
-  src="https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/issuehunt-logo.svg?sanitize=true">
+  src="https://raw.githubusercontent.com/pirix-gh/ts-toolbelt/master/.github/issuehunt-logo.svg?sanitize=true">
 </a>
@@ -204,2 +239,3 @@ <br>
 #### For this project
+
 To run the `lint` & `type` tests, simply run:
@@ -212,6 +248,7 @@
 #### For your project
+
 Want to test your own types? Let's get started:
 
 ```ts
-import {A, B, C, F, I, N, O, S, T, U, Test} from 'eledoc'
+import {A, B, C, F, I, N, O, S, T, U, Test} from 'ts-toolbelt'
 
@@ -233,7 +270,14 @@ const {checks, check} = Test
 
-| eledoc | typescript |
+| ts-toolbelt | typescript |
 |-------------|------------|
-| 1.0.x       | 3.5.x      |
+| 1.x.x       | ~3.5.x     |
+| 2.x.x       | ^3.5.x     |
+| 3.x.x       | ^3.5.x     |
 
+Major version numbers will upgrade whenever TypeScript had breaking changes (it
+happened that TS had breaking changes on minor versions). Otherwise, the release
+versions will naturally follow the semantic versioning.
+
 ## 🔮 What's next
+
 * Automated performance tests
@@ -250,7 +294,9 @@ ```sh
 Many, many thanks to all the
-[contributors](https://github.com/pirix-gh/eledoc/graphs/contributors) and:
+[contributors](https://github.com/pirix-gh/ts-toolbelt/graphs/contributors) and:
 
 * [André Staltz](https://github.com/staltz)
+* [Joe Calzaretta](https://github.com/jcalz)
 * [Matt McCutchen](https://github.com/mattmccutchen)
 
-## 💟 Friendly Projects
+## 💟 Friendly Projects
+- [`utility-types`](https://github.com/piotrwitek/utility-types) - Collection of utility types, complementing TypeScript built-in mapped types and aliases

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

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

Improved metrics

Total package byte prevSize

513753

increased by0.83%

Number of package files

67

increased by3.08%

Lines of code

2280

increased by1.11%

Number of lines in readme file

283

increased by19.92%

No dependency changes