Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
mfix22 committed Jul 20, 2018
1 parent f1bde4e commit c2b2091
Show file tree
Hide file tree
Showing 9 changed files with 129 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/credit-card/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-credit-card`

### Install
```bash
$ npm install --save graphql-types-credit-card
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)
9 changes: 9 additions & 0 deletions packages/drivers-license/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-drivers-license`

### Install
```bash
$ npm install --save graphql-types-drivers-license
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)
9 changes: 9 additions & 0 deletions packages/enum/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-enum`

### Install
```bash
$ npm install --save graphql-types-enum
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)
57 changes: 57 additions & 0 deletions packages/gnt/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# *G*raphQL *N*ormalized *T*ypes :cocktail:
The **g**in-**n**-**t**onic of GraphQL types: simple, final, clean. Normalize your common data with GraphQL Scalar types.

[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#contributing)
## Usage
```bash
$ npm install --save gnt
```

and then add to your schema:

```javascript
const { Phone, UnixDate, CreditCard, State, ZipCode, DriversLicense } = require('gnt')

{
name: 'Query',
fields: {
phone: { type: Phone },
date: { type: UnixDate },
card: { type: CreditCard },
state: { type: State }
zipcode: { type: ZipCode },
license: { type: DriversLicense }
}
}
```

## Examples
Each of these types can be installed individually using there 'Package Name' shown below

| Type | Package Name | Input Example | Output Example |
| :------------- | :------------- | :------------- | :------------- |
| Phone | `graphql-types-phone` | `'(817) 569-8900'` | `'+18175698900'` |
| Zipcode | `graphql-types-zipcode` | `'55902'`, `00000` | `'55902'`, `null` |
| UnixDate | `graphql-types-unix-timestamp` | `2017-05-07T14:47:59.438`, `Date` | `1494186489` |
| CreditCard | `graphql-types-credit-card` | `'4111111111111111'` | ```{ number: '4111111111111111', cardType: 'VISA', validCVV: false, validExpiryMonth: false, validExpiryYear: false, isExpired: true }``` |
| NonEmptyString | `graphql-types-non-empty-string` | `''` | `null` |
| Drivers License| `graphql-types-drivers-license` | `{ state: 'CA', license: 'B2347354' }`| `{ state: 'CA', license: 'B2347354' }` OR `null` |
#### Enum Types
| Type | Package Name | Input Example |
| :------------- | :------------- | :------------- |
| USState | `graphql-types-us-state` | `US`, `CA`, `DE` `...` |

## Contributing
Contributions are more than welcome! This repo is not meant to be owned by me (and if there is a more suitable owner please [let me know](https://github.com/mfix22/gnt/issues)), but rather by the commuity.

### Creating a new type
First run:
```shell
$ npm run generate -- '<your type name>'
```
to get started. A folder with `index.js`, `index.spec.js` (your test), and a `package.json` will be created for you!
Then run `npm run link` and you should be on your way.

If you have any idea for new types, please submit an issue or PR!
9 changes: 9 additions & 0 deletions packages/non-empty-string/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-non-empty-string`

### Install
```bash
$ npm install --save graphql-types-non-empty-string
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)
9 changes: 9 additions & 0 deletions packages/phone/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-phone`

### Install
```bash
$ npm install --save graphql-types-phone
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)
9 changes: 9 additions & 0 deletions packages/unix-date/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-unix-timestamp`

### Install
```bash
$ npm install --save graphql-types-unix-timestamp
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)
9 changes: 9 additions & 0 deletions packages/us-state/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-us-state`

### Install
```bash
$ npm install --save graphql-types-us-state
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)
9 changes: 9 additions & 0 deletions packages/zipcode/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# `graphql-types-zipcode`

### Install
```bash
$ npm install --save graphql-types-zipcode
```

### Usage
Check out examples [here](https://github.com/mfix22/gnt/tree/master/packages/gnt)

0 comments on commit c2b2091

Please sign in to comment.