This repository has been archived by the owner on Sep 8, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #177 from guardian/archive-readme-message
Update README.md before archiving repo
- Loading branch information
Showing
1 changed file
with
4 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,7 @@ | ||
⚠️ **Deprecation warning: This package will soon be migrated to [guardian/libs](https://github.com/guardian/libs) and will be archived. ** | ||
# `@guardian/types` | ||
|
||
# types | ||
⚠️ Guardian-specific TypeScript types have been migrated to [@guardian/libs](https://github.com/guardian/libs). | ||
|
||
A place for types | ||
`Option`/`Result` are still available in v9 of this package to accommodate existing usage, but v9 will be the last version of this package. | ||
|
||
## Add to a project | ||
|
||
With NPM: | ||
|
||
``` | ||
$ npm install -D @guardian/types | ||
``` | ||
|
||
With Yarn: | ||
|
||
``` | ||
$ yarn add -D @guardian/types | ||
``` | ||
|
||
## Development | ||
|
||
### Run the tests | ||
|
||
``` | ||
$ npm test | ||
``` | ||
|
||
### Publish to NPM | ||
|
||
We use the [np library](https://github.com/sindresorhus/np) to publish. | ||
|
||
``` | ||
$ npm run release | ||
``` | ||
If continued development is needed on them, [they should really be maintained and published elsewhere](https://github.com/guardian/types/issues/5#issuecomment-610876533). |