Skip to content

Commit

Permalink
Making much better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dr-dimitru committed Jul 6, 2015
1 parent 5269a0a commit e4896e8
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/VeliovGroup/Meteor-Files)

- [Overview](#meteor-files)
- [Why this package?](#why-meteor-files)
- [Install](#install)
- [API](#api)
* [new Meteor.Files()](#new-meteorfilesconfig-isomorphic) [*Isomorphic*]
* [Chunk Streaming](#file-streaming) [*Example*]
* [Force Download](#file-download) [*Example*]
* [Schema](#current-schema) [*Isomorphic*]
- [Template Helper](#template-helper)
* [Force Download](#to-get-download-url-for-file-you-only-need-fileref-object-so-there-is-no-need-for-subscription) [*Example*]
* [Get file subversion](#to-get-specific-version-of-the-file-use-second-argument-version) [*Example*]
* [Thumbnail Example](#to-display-thumbnail) [*Example*]
* [Video Streaming Example](#to-stream-video) [*Example*]
- [General Methods](#methods)
* [Insert (Upload) File(s)](#insertsettings-client) [*Client*]
* [Collection](#collection--isomorphic) [*Isomorphic*]
* [findOne()](#findonesearch--isomorphic) [*Isomorphic*]
* [find()](#findsearch--isomorphic) [*Isomorphic*]
* [write()](#writebuffer-options-callback--server) [*Server*]

Meteor-Files
========
This package allows to:
Expand Down Expand Up @@ -41,7 +63,7 @@ meteor add ostrio:files

API
========
###### `new Meteor.Files([config])` [{*Isomorphic*}]
###### `new Meteor.Files([config])` [*Isomorphic*]

`config` is __optional__ object with next properties:
- `storagePath` {*String*} - Storage path on file system
Expand Down

0 comments on commit e4896e8

Please sign in to comment.