Skip to content

Commit d2ea13e

Browse files
authored
Merge pull request #6 from canjs/dev-rel-12-update-generated-readmes
Remove generated API docs from the README
2 parents 4dc4d3e + 6e84f13 commit d2ea13e

File tree

2 files changed

+13
-43
lines changed

2 files changed

+13
-43
lines changed

README.md

Lines changed: 12 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,26 @@
11
# can-ajax
22

3+
[![Join the chat at https://gitter.im/canjs/canjs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/canjs/canjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/canjs/can-ajax/blob/master/LICENSE)
5+
[![npm version](https://badge.fury.io/js/can-ajax.svg)](https://www.npmjs.com/package/can-ajax)
6+
[![Travis build status](https://travis-ci.org/canjs/can-ajax.svg?branch=master)](https://travis-ci.org/canjs/can-ajax)
37
[![Greenkeeper badge](https://badges.greenkeeper.io/canjs/can-ajax.svg)](https://greenkeeper.io/)
48

5-
[![Build Status](https://travis-ci.org/canjs/can-ajax.png?branch=master)](https://travis-ci.org/canjs/can-ajax)
6-
79
jQuery-inspired AJAX request library.
810

9-
## Usage
10-
11-
### ES6 use
12-
13-
With StealJS, you can import this module directly in a template that is autorendered:
14-
15-
```js
16-
import plugin from 'can-ajax';
17-
```
18-
19-
### CommonJS use
11+
## Documentation
2012

21-
Use `require` to load `can-ajax` and everything else
22-
needed to create a template that uses `can-ajax`:
13+
Read the [can-ajax API docs on CanJS.com](https://canjs.com/doc/can-ajax.html).
2314

24-
```js
25-
var plugin = require("can-ajax");
26-
```
15+
## Changelog
2716

28-
## AMD use
17+
See the [latest releases on GitHub](https://github.com/canjs/can-ajax/releases).
2918

30-
Configure the `can` and `jquery` paths and the `can-ajax` package:
19+
## Contributing
3120

32-
```html
33-
<script src="require.js"></script>
34-
<script>
35-
require.config({
36-
paths: {
37-
"jquery": "node_modules/jquery/dist/jquery",
38-
"can": "node_modules/canjs/dist/amd/can"
39-
},
40-
packages: [{
41-
name: 'can-ajax',
42-
location: 'node_modules/can-ajax/dist/amd',
43-
main: 'lib/can-ajax'
44-
}]
45-
});
46-
require(["main-amd"], function(){});
47-
</script>
48-
```
21+
The [contribution guide](https://github.com/canjs/can-ajax/blob/master/CONTRIBUTING.md) has information on getting help, reporting bugs, developing locally, and more.
4922

50-
### Standalone use
23+
## License
5124

52-
Load the `global` version of the plugin:
25+
[MIT](https://github.com/canjs/can-ajax/blob/master/LICENSE)
5326

54-
```html
55-
<script src='./node_modules/can-ajax/dist/global/can-ajax.js'></script>
56-
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@
6363
"donejs-cli": "^1.0.0",
6464
"done-serve": "^1.0.0"
6565
}
66-
}
66+
}

0 commit comments

Comments
 (0)