Skip to content

Commit

Permalink
feat: rename pacakge to @gorhom/codable
Browse files Browse the repository at this point in the history
  • Loading branch information
gorhom committed Apr 11, 2020
1 parent b0f184f commit 4c3f03e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 14 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# TypeScript Codable [![npm](https://img.shields.io/npm/v/ts-codable)](https://www.npmjs.com/package/ts-codable) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/ts-codable)](https://www.npmjs.com/package/ts-codable)
# Codable [![npm](https://img.shields.io/npm/v/@gorhom/codable)](https://www.npmjs.com/package/@gorhom/codable) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/@gorhom/codable)](https://www.npmjs.com/package/@gorhom/codable) [![npm](https://badgen.net/npm/dependents/@gorhom/codable)](https://www.npmjs.com/package/@gorhom/codable)

another strict json parser inspired by [Swift Codable](https://developer.apple.com/documentation/swift/codable) ❤️
A strict json parser inspired by [Swift Codable](https://developer.apple.com/documentation/swift/codable/) ❤️

![Alt text](docs/cover.png 'Title')
![Alt text](docs/cover.png 'Cover')

## Features

Expand Down Expand Up @@ -30,15 +30,15 @@ Types design was inspired by [MobX State Tree](https://github.com/mobxjs/mobx-st
## Installation

```bash
yarn add ts-codable
yarn add @gorhom/codable
# or
npm install ts-codable
npm install @gorhom/codable
```

## Usage

```ts
import { BaseCodable, types, decode } from 'ts-codable';
import { BaseCodable, types, decode } from '@gorhom/codable';
import dayjs from 'dayjs';

class Post extends BaseCodable {
Expand Down Expand Up @@ -96,8 +96,8 @@ const user: User = decode(User, jsonPayload);

## Built With

- [TSdx](https://github.com/jaredpalmer/tsdx) - Zero-config TypeScript package development.
- [TypeScript](https://github.com/Microsoft/TypeScript) - Strict syntactical superset of JavaScript.
- [TSdx](https://github.com/jaredpalmer/tsdx)
- [TypeScript](https://github.com/Microsoft/TypeScript)

## Author

Expand Down
Binary file modified docs/cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
{
"name": "ts-codable",
"name": "@gorhom/codable",
"description": "A strict json parser inspired by Swift Codable",
"version": "0.4.2",
"private": false,
"main": "dist/index.js",
"module": "dist/ts-codable.esm.js",
"module": "dist/codable.esm.js",
"typings": "dist/index.d.ts",
"files": [
"dist"
],
"repository": {
"type": "git",
"url": "https://github.com/gorhom/ts-codable.git"
"url": "https://github.com/gorhom/codable.git"
},
"keywords": [
"ts-codable",
Expand All @@ -27,9 +28,9 @@
"author": "Mo Gorhom",
"license": "MIT",
"bugs": {
"url": "https://github.com/gorhom/ts-codable/issues"
"url": "https://github.com/gorhom/codable/issues"
},
"homepage": "https://github.com/gorhom/ts-codable",
"homepage": "https://github.com/gorhom/codable",
"scripts": {
"start": "tsdx watch",
"build": "tsdx build",
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"baseUrl": "./",
"paths": {
"*": ["src/*", "node_modules/*"],
"ts-codable": ["src/internal"]
"@gorhom/codable": ["src/internal"]
},
"jsx": "react",
"esModuleInterop": true
Expand Down

0 comments on commit 4c3f03e

Please sign in to comment.