Skip to content
This repository has been archived by the owner on Sep 8, 2021. It is now read-only.

Commit

Permalink
Merge pull request #177 from guardian/archive-readme-message
Browse files Browse the repository at this point in the history
Update README.md before archiving repo
  • Loading branch information
sndrs committed Sep 8, 2021
2 parents 6929c94 + b66dd21 commit fd511f5
Showing 1 changed file with 4 additions and 32 deletions.
36 changes: 4 additions & 32 deletions README.md
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).

0 comments on commit fd511f5

Please sign in to comment.