Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrwitek committed Nov 2, 2019
1 parent 671a5f6 commit 92ee9a2
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 27 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Contributing Guide

1. Make sure you have read and understand the **Motivation** and **Goals** section to be aligned with the project goals.
1. Make sure you have read and understand the **Motivation** section to be aligned with the project goals.
2. Before submitting a PR please make a comment in the relevant issue to inform maintainers that you would like to work on it.
3. If this is something new and there is no issue asociated with the PR you would want to create it first using either "Feature Request" or "Bug Report" template.
4. All workflow scripts (like prettier, linter, tests) have to pass successfully. They are run on a CI server by `npm run ci-check` script.
Expand Down
53 changes: 27 additions & 26 deletions README.md
Expand Up @@ -33,48 +33,47 @@ _Found it useful? Want more updates?_

</div>

## Features

## TypeScript compatibility notes
* v1 - minimum TS v2.7.2
* v2 - minimum TS v2.8.1 (rewritten to conditional types)
* v3 - minimum TS v3.1.0

## Motivation

The primary goal of this library is to provide a set of proven Utility Types that should complement existing [TypeScript Mapped Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html).

The secondary goal is to provide a few additional utility types compatible with [Flow's Utility Types](https://flow.org/en/docs/types/utilities/) helping with gradual migration between "Flow" and "TypeScript" projects.
* Providing a set of [Common Types](#table-of-contents) for TypeScript projects that are idiomatic and complementary to existing [TypeScript Mapped Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html) so you don't need to copy them between the projects.
* Providing a set of [Additional Types](#) compatible with [Flow's Utility Types](https://flow.org/en/docs/types/utilities/) to allow much easier migration to `TypeScript`.

## Goals

* provide a set of consistent Utility Types that are idiomatic and complementary to existing [TypeScript Mapped Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html)
* provide migration from [Flow's Utility Types](https://flow.org/en/docs/types/utilities/)
* clean idiomatic implementation based on composition of smaller generic types that are easy to follow and learn how they work

## Features

* Thoroughly tested for type correctness with type-testing library `dts-jest`
* Safe with minimal footprint - no third-party dependencies
* Quality - thoroughly tested for type correctness with type-testing library `dts-jest`
* Secure and minimal - no third-party dependencies
* No runtime cost - it's type-level only

## Installation

```bash
npm install --save utility-types
# NPM
npm install utility-types

# YARN
yarn add utility-types
```

## Contributing Guide
We are open for contributions. If you're planning to contribute please make sure to read the contributing guide: [CONTRIBUTING.md](/CONTRIBUTING.md)
## Compatibility Notes

**TypeScript support**
* `v3.x.x` - TypeScript v3.1+
* `v2.x.x` - TypeScript v2.8.1+
* `v1.x.x` - TypeScript v2.7.2+

## Sponsor
**Utility-Types** is an independent open-source project created by people investing their free time for the benefit of our community.
## Funding Issues
**Utility-Types** is an open-source project created by people investing their time for the benefit of our community.

If you are using **Utility-Types** please consider donating as this will guarantee the project will be updated and maintained in the long run.
Issues like bug fixes or feature requests can be very quickly resolved when funded through the IssueHunt platform.

Issues can be funded by anyone and the money will be transparently distributed to the contributors handling a particular issue.
I highly recommend adding a bounty to the issue that you're waiting for to attract some contributors willing to work on it.

[![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/repos/76400842)

## Contributing

We are open for contributions. If you're planning to contribute please make sure to read the contributing guide as it can save you from wasting your time: [CONTRIBUTING.md](/CONTRIBUTING.md)

---

* _(built-in)_ - types built-in TypeScript, no need to import
Expand Down Expand Up @@ -1123,6 +1122,8 @@ https://flow.org/en/docs/types/mixed

---

MIT License
## License

[MIT License](/LICENSE)

Copyright (c) 2016 Piotr Witek <mailto:piotrek.witek@gmail.com> (http://piotrwitek.github.io)

0 comments on commit 92ee9a2

Please sign in to comment.