|
1 | 1 | # can-ajax
|
2 | 2 |
|
| 3 | +[](https://gitter.im/canjs/canjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 4 | +[](https://github.com/canjs/can-ajax/blob/master/LICENSE) |
| 5 | +[](https://www.npmjs.com/package/can-ajax) |
| 6 | +[](https://travis-ci.org/canjs/can-ajax) |
3 | 7 | [](https://greenkeeper.io/)
|
4 | 8 |
|
5 |
| -[](https://travis-ci.org/canjs/can-ajax) |
6 |
| - |
7 | 9 | jQuery-inspired AJAX request library.
|
8 | 10 |
|
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 |
20 | 12 |
|
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). |
23 | 14 |
|
24 |
| -```js |
25 |
| -var plugin = require("can-ajax"); |
26 |
| -``` |
| 15 | +## Changelog |
27 | 16 |
|
28 |
| -## AMD use |
| 17 | +See the [latest releases on GitHub](https://github.com/canjs/can-ajax/releases). |
29 | 18 |
|
30 |
| -Configure the `can` and `jquery` paths and the `can-ajax` package: |
| 19 | +## Contributing |
31 | 20 |
|
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. |
49 | 22 |
|
50 |
| -### Standalone use |
| 23 | +## License |
51 | 24 |
|
52 |
| -Load the `global` version of the plugin: |
| 25 | +[MIT](https://github.com/canjs/can-ajax/blob/master/LICENSE) |
53 | 26 |
|
54 |
| -```html |
55 |
| -<script src='./node_modules/can-ajax/dist/global/can-ajax.js'></script> |
56 |
| -``` |
0 commit comments