From 256f87e9542ec841693a0af3e260527790a39530 Mon Sep 17 00:00:00 2001 From: Nick Uraltsev Date: Thu, 31 Mar 2016 13:04:30 -0700 Subject: [PATCH] Add Resources section to README.md --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index be573d6..427c630 100644 --- a/README.md +++ b/README.md @@ -180,12 +180,12 @@ These are the available config options for making requests. Only the `url` is re { // `url` is the server URL that will be used for the request url: '/user', - + // `method` is the request method to be used when making the request method: 'get', // default - // `baseURL` will be prepended to `url` unless `url` is absolute. - // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs + // `baseURL` will be prepended to `url` unless `url` is absolute. + // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs // to methods of that instance. baseURL: 'https://some-domain.com/api/', @@ -264,7 +264,7 @@ These are the available config options for making requests. Only the `url` is re progress: function(progressEvent) { // Do whatever you want with the native progress event }, - + // `maxContentLength` defines the max size of the http response content allowed maxContentLength: 2000 } @@ -346,7 +346,7 @@ instance.defaults.timeout = 2500; // Override timeout for this request as it's known to take a long time instance.get('/longRequest', { timeout: 5000 -}); +}); ``` ## Interceptors @@ -423,6 +423,13 @@ import * as axios from 'axios'; axios.get('/user?ID=12345'); ``` +## Resources + +* [Changelog](https://github.com/mzabriskie/axios/blob/master/CHANGELOG.md) +* [Ecosystem](https://github.com/mzabriskie/axios/blob/master/ECOSYSTEM.md) +* [Contributing Guide](https://github.com/mzabriskie/axios/blob/master/CONTRIBUTING.md) +* [Code of Conduct](https://github.com/mzabriskie/axios/blob/master/CODE_OF_CONDUCT.md) + ## Credits axios is heavily inspired by the [$http service](https://docs.angularjs.org/api/ng/service/$http) provided in [Angular](https://angularjs.org/). Ultimately axios is an effort to provide a standalone `$http`-like service for use outside of Angular.