Skip to content

Commit d363553

Browse files
committed
Update readme
1 parent db6caf3 commit d363553

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
11
<img src="https://github.com/raw/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="64" height="64" />
22

3-
## js-data-sql [![npm version](https://img.shields.io/npm/v/js-data-sql.svg?style=flat-square)](https://www.npmjs.org/package/js-data-sql) [![Circle CI](https://img.shields.io/circleci/project/js-data/js-data-sql/master.svg?style=flat-square)](https://circleci.com/gh/js-data/js-data-sql/tree/master) [![npm downloads](https://img.shields.io/npm/dm/js-data-sql.svg?style=flat-square)](https://www.npmjs.org/package/js-data-sql) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/js-data/js-data-sql/blob/master/LICENSE)
3+
## js-data-sql [![npm version](https://img.shields.io/npm/v/js-data-sql.svg?style=flat-square)](https://www.npmjs.org/package/js-data-sql) [![Circle CI](https://img.shields.io/circleci/project/js-data/js-data-sql/master.svg?style=flat-square)](https://circleci.com/gh/js-data/js-data-sql/tree/master) [![npm downloads](https://img.shields.io/npm/dm/js-data-sql.svg?style=flat-square)](https://www.npmjs.org/package/js-data-sql)
44

55
Postgres/MySQL/MariaDB/SQLite3 adapter for [js-data](http://www.js-data.io/).
66

77
### API Documentation
88
[DSSqlAdapter](http://www.js-data.io/docs/dssqladapter)
99

10-
### Project Status
11-
12-
__Latest Release:__ [![Latest Release](https://img.shields.io/github/release/js-data/js-data-sql.svg?style=flat-square)](https://github.com/js-data/js-data-sql/releases)
13-
14-
__Status:__
15-
16-
[![Dependency Status](https://img.shields.io/gemnasium/js-data/js-data-sql.svg?style=flat-square)](https://gemnasium.com/js-data/js-data-sql) [![Codacy](https://img.shields.io/codacy/4da2bc1bbca74fd38c4532cb8bc8d40a.svg?style=flat-square)](https://www.codacy.com/public/jasondobry/js-data-sql/dashboard)
17-
18-
__Supported Platforms:__
19-
20-
[![node version](https://img.shields.io/badge/Node-0.10%2B-green.svg?style=flat-square)](https://github.com/js-data/js-data)
21-
2210
### Quick Start
2311
`npm install --save js-data js-data-sql`.
2412

@@ -73,15 +61,29 @@ When submitting issues on GitHub, please include as much detail as possible to m
7361
1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
7462
1. Fork js-data-sql
7563
1. `git clone [email protected]:<you>/js-data-sql.git`
76-
1. `cd js-data-sql; npm install; bower install;`
64+
1. `cd js-data-sql; npm install;`
7765
1. Write your code, including relevant documentation and tests
78-
1. Run `grunt test` (build and test)
66+
1. Run `npm test` (build and test)
7967
- You need io.js or Node 4.x that includes generator support without a flag
8068
1. Your code will be linted and checked for formatting, the tests will be run
8169
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
8270
1. Submit your PR and we'll review!
8371
1. Thanks!
8472

73+
#### Have write access?
74+
75+
Here's how to make a release on the `master` branch:
76+
77+
1. Bump `package.json` to the appropriate version.
78+
1. `npm test` must succeed.
79+
1. This time, the built `dist/js-data-sql.js` file _will_ be committed, so stage its changes.
80+
1. Mention the release version in the commit message, e.g. `Stable Version 1.2.3`
81+
1. Push to master.
82+
1. Create a git tag. Name it the version of the release, e.g. `1.2.3`
83+
- Easiest way is to just create a GitHub Release, which will create the tag for you. Name the Release and the git tag the same thing.
84+
1. `git fetch origin` if you tagged it via GitHub Release, so you can get the tag on your local machine.
85+
1. `npm publish .` (Make sure you got the version bumped correctly!)
86+
8587
### License
8688

8789
The MIT License (MIT)

0 commit comments

Comments
 (0)