Skip to content

Commit

Permalink
Move dist/ files to another branch
Browse files Browse the repository at this point in the history
  • Loading branch information
jmdobry committed Apr 28, 2016
1 parent 04e27fe commit d43e483
Show file tree
Hide file tree
Showing 16 changed files with 52 additions and 10,196 deletions.
40 changes: 28 additions & 12 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,43 @@
# Contributing
# Contributing to js-data core

[Read the Contributing Guide](http://js-data.io/docs/contributing).
[Read the general Contributing Guide](http://js-data.io/docs/contributing).

## Support
## Project structure

[Find out how to Get Support](http://js-data.io/docs/support).
* `dist/` - Contains final build files for distribution (js-data-http)
* `doc/` - Output folder for JSDocs
* `fetch/` - Contains js-data-fetch package files
* `dist/` - Contains final build files for distribution (js-data-fetch)
* `node/` - Contains js-data-http-node package files
* `dist/` - Contains final build files for distribution (js-data-http-node)
* `scripts/ - Various build scripts
* `src/` - Project source code
* `test/` - Project tests

## Community
## Clone, build & test

[Explore the Community](http://js-data.io/docs/community).
1. `clone [email protected]:js-data/js-data-http.git`
1. `cd js-data-http`
1. `npm install`
1. `npm test` - Build and test

### Have write access?

To cut a release:
## To cut a release

1. Checkout master
1. Bump version in `package.json` appropriately
1. Run `npm run release`
1. Update `CHANGELOG.md` appropriately
1. Commit and push changes, including the `dist/` folder
1. Run `npm run release`
1. Commit and push changes
1. Checkout `release`, merge `master` into `release`
1. Run `npm run release` again
1. Commit and push changes
1. Make a GitHub release
- tag from `release` branch
- set tag name to version
- set release name to version
- set release body to changelog entry for the version
- attach the files in the `dist/` folder
- upload the files in the `dist/` folder
1. `npm publish .`
1. checkout `master`

See also [Community & Support](http://js-data.io/docs/community).
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
dist/*.js
dist/*.map
bower_components/

.idea/
Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
##### 3.0.0-beta.3 - 28 April 2016

###### Breaking changes
- js-data-http.js no longer exports a default module, you must now do:
- js-data-http/js-data-fetch/js-data-http-node no longer export a default module, instead you must do:
- `import {HttpAdapter} from 'js-data-http'
- `var HttpAdapter = require('js-data-http').HttpAdapter
- `var adapter = new window.JSDataHttp.HttpAdapter()`
- `define(['js-data-http'], function (JSDataHttp) { var adapter = new window.JSDataHttp.HttpAdapter(); })
- Removed `dist/` files from the `master` branch to a `release` branch to cut down on noise

###### Backwards compatible changes
- Added `typings` field to `package.json`
Expand Down
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,33 @@

[![Slack Status][sl_b]][sl_l]
[![npm version][npm_b]][npm_l]
[![Circle CI][circle_b]][circle_l]
[![npm downloads][dn_b]][dn_l]
[![Circle CI][circle_b]][circle_l]
[![Coverage Status][cov_b]][cov_l]
[![Codacy][cod_b]][cod_l]

This repo contains HTTP adapters for [js-data](http://www.js-data.io/):

- js-data-http - HTTP (XHR, includes [axios][axios]) adapter for js-data in the
browser. Capable of using `window.fetch` instead of axios.
- js-data-fetch - Same as js-data-http but doesn't include axios and will use
- js-data-http - HTTP (XHR, includes [`axios`][axios]) adapter for JSData in the
browser. Capable of using `window.fetch` instead of axios. __Only works in the browser__.
- js-data-fetch - Same as `js-data-http` but _does not_ include `axios` and will use
`window.fetch` if available and if you don't provide your own http library.
- js-data-http-node - Same as js-data-http but runs on Node.js. Depends on axios
and will use axios unless you provide a different http library.
- js-data-http-node - Same as `js-data-http` but runs on Node.js. Depends on `axios`
and will use `axios` unless you provide a different http library.

Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using
<img src="https://raw.githubusercontent.com/js-data/js-data-localstorage/master/bs.jpg" alt="bs logo" title="browserstack" width="150" height="35" style="vertical-align: middle" />

To get started, visit the main website at __[http://js-data.io](http://www.js-data.io/v3.0/docs/js-data-http)__.
To get started, visit the main website at __[http://js-data.io](http://www.js-data.io)__.

## Links

* [Quick start](http://www.js-data.io/v3.0/docs/js-data-http)
* [Guides and Tutorials](http://www.js-data.io/v3.0/docs/home)
* [API Reference Docs](http://api.js-data.io/js-data-http)
* [Community](http://js-data.io/docs/community)
* [Support](http://js-data.io/docs/support)
* [Contributing](http://js-data.io/docs/contributing)
* [Quick start](http://www.js-data.io/v3.0/docs/home#quick-start) - Get started in 5 minutes
* [Guides and Tutorials](http://www.js-data.io/v3.0/docs/home) - Learn how to use JSData
* [HttpAdapter Guide](http://www.js-data.io/v3.0/docs/js-data-http) - Learn how to use the HttpAdapter
* [API Reference Docs](http://api.js-data.io) - Explore components, methods, options, etc.
* [Community & Support](http://js-data.io/docs/community) - Find solutions and chat with the community
* [General Contributing Guide](http://js-data.io/docs/contributing) - Give back and move the project forward
* [Contributing to js-data-http](https://github.com/js-data/js-data-http/blob/master/.github/CONTRIBUTING.md)

## License

Expand All @@ -44,14 +44,11 @@ Copyright (c) 2014-2016 js-data-http project authors

[sl_b]: http://slack.js-data.io/badge.svg
[sl_l]: http://slack.js-data.io
[so]: http://stackoverflow.com/questions/tagged/jsdata
[npm_b]: https://img.shields.io/npm/v/js-data-http.svg?style=flat
[npm_l]: https://www.npmjs.org/package/js-data-http
[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-http/master.svg?style=flat
[circle_l]: https://circleci.com/gh/js-data/js-data-http/tree/master
[dn_b]: https://img.shields.io/npm/dm/js-data-http.svg?style=flat
[dn_l]: https://www.npmjs.org/package/js-data-http
[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-http/master.svg?style=flat
[circle_l]: https://circleci.com/gh/js-data/js-data-http/tree/master
[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-http/3.0.svg?style=flat
[cov_l]: https://codecov.io/github/js-data/js-data-http
[cod_b]: https://img.shields.io/codacy/3931bbd8d838463297f70640aa78251b.svg
[cod_l]: https://www.codacy.com/app/jasondobry/js-data-http/dashboard
Loading

0 comments on commit d43e483

Please sign in to comment.