Skip to content

Commit

Permalink
Update documentatation for v2.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
nicksay committed Jun 9, 2016
1 parent 3d95ed9 commit f38661a
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 17 deletions.
6 changes: 4 additions & 2 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ layout: api
---


The following API reference is for **SPF 23 (v2.3.2)**.
The following API reference is for **SPF 24 (v2.4.0)**.


* * *
Expand Down Expand Up @@ -173,7 +173,7 @@ The string "multipart".
Definition for options when requesting a URL.

**Attributes**
`experimental_headers: Object.<string> | undefined`
`headers: Object.<string> | undefined`
Optional map of headers to send with the request.
`method: string | undefined`
Optional method with which to send the request; defaults to "GET".
Expand Down Expand Up @@ -260,6 +260,8 @@ The URL of the previous page; defined for "spfhistory" and
A complete SPF response; defined for "spfprocess" events as a single
response and for "spfdone" events as either a single or multipart
response (see [spf.SingleResponse](#spf.singleresponse) and [spf.MultipartResponse](#spf.multipartresponse).
`xhr: XMLHttpRequest | undefined`
A complete XMLHttpRequest object; defined for "onError" events.
`target: Element | undefined`
The target element of a click; defined for "spfclick" events.
`url: string | undefined`
Expand Down
26 changes: 13 additions & 13 deletions doc/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,31 +25,31 @@ bower install spf
You can link to the JS files directly from several popular CDNs:

- [Google Hosted Libraries][]
`https://ajax.googleapis.com/ajax/libs/spf/2.3.2/spf.js`
`https://ajax.googleapis.com/ajax/libs/spf/2.4.0/spf.js`
- [cdnjs][]
`https://cdnjs.cloudflare.com/ajax/libs/spf/2.3.2/spf.js`
`https://cdnjs.cloudflare.com/ajax/libs/spf/2.4.0/spf.js`
- [jsDelivr][]
`https://cdn.jsdelivr.net/spf/2.3.2/spf.js`
`https://cdn.jsdelivr.net/spf/2.4.0/spf.js`
- [OSSCDN][]
`https://oss.maxcdn.com/spf/2.3.2/spf.js`
`https://oss.maxcdn.com/spf/2.4.0/spf.js`


## Download a release

Download just the minified JS files:
**[spfjs-2.3.2-dist.zip][spfjs-dist-zip]**
**[spfjs-2.4.0-dist.zip][spfjs-dist-zip]**

```sh
curl -LO https://github.com/youtube/spfjs/releases/download/v2.3.2/spfjs-2.3.2-dist.zip
unzip spfjs-2.3.2-dist.zip
curl -LO https://github.com/youtube/spfjs/releases/download/v2.4.0/spfjs-2.4.0-dist.zip
unzip spfjs-2.4.0-dist.zip
```

Or, download the minified files and complete source code:
**[v2.3.2.zip][spfjs-src-zip]**
**[v2.4.0.zip][spfjs-src-zip]**

```sh
curl -LO https://github.com/youtube/spfjs/archive/v2.3.2.zip
unzip v2.3.2.zip
curl -LO https://github.com/youtube/spfjs/archive/v2.4.0.zip
unzip v2.4.0.zip
```


Expand All @@ -60,7 +60,7 @@ Clone the project from GitHub and checkout the release:
```sh
git clone https://github.com/youtube/spfjs.git
cd spfjs
git checkout v2.3.2
git checkout v2.4.0
```


Expand All @@ -77,5 +77,5 @@ After you've grabbed the code, **[get started][]**.
[cdnjs]: https://cdnjs.com/libraries/spf
[jsDelivr]: http://www.jsdelivr.com/#!spf
[OSSCDN]: http://osscdn.com/#/spf
[spfjs-dist-zip]: https://github.com/youtube/spfjs/releases/download/v2.3.2/spfjs-2.3.2-dist.zip
[spfjs-src-zip]: https://github.com/youtube/spfjs/archive/v2.3.2.zip
[spfjs-dist-zip]: https://github.com/youtube/spfjs/releases/download/v2.4.0/spfjs-2.4.0-dist.zip
[spfjs-src-zip]: https://github.com/youtube/spfjs/archive/v2.4.0.zip
4 changes: 2 additions & 2 deletions web/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ baseurl: /spfjs
title: SPF
description: A lightweight JS framework for fast navigation and page updates from YouTube

release: SPF 23 (v2.3.2)
version: 2.3.2
release: SPF 24 (v2.4.0)
version: 2.4.0

exclude:
- Gemfile
Expand Down

0 comments on commit f38661a

Please sign in to comment.