Skip to content

Update README.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Angular File is an Angularjs component that can upload files via XMLHttpRequest,

![](http://modulr.io/img/preview/mdr-angular-file.png)

##Features
## Features

- Uses the native Angularjs scope for data binding
- Drag & Drop
Expand All @@ -16,12 +16,12 @@ Angular File is an Angularjs component that can upload files via XMLHttpRequest,
- Large files support


##Requirements
## Requirements

- [Angularjs](https://angularjs.org/)
- [Bootstrap 3.](http://getbootstrap.com/)

##Quick start
## Quick start

Several quick start options are available:

Expand All @@ -30,7 +30,7 @@ Several quick start options are available:
- Install with [Bower](http://bower.io/): `bower install mdr-angular-file`.
- Install with [npm](https://www.npmjs.com): `npm install mdr-angular-file`.

##What's included
## What's included

```
mdr-angular-file/
Expand All @@ -41,29 +41,29 @@ mdr-angular-file/
└── mdr-file.min.js
```

##Documentation
## Documentation

####Usage
#### Usage

######Load CSS
###### Load CSS

```html
<link href="mdr-angular-file/dist/mdr-file.min.css">
```

######Load JS
###### Load JS

```html
<script href="mdr-angular-file/dist/mdr-file.min.js"></script>
```

######Code
###### Code

```js
angular.module('MyApp', ['mdr.file'])
```

######HTML View or Templates
###### HTML View or Templates

> Basic Directive

Expand All @@ -77,9 +77,9 @@ angular.module('MyApp', ['mdr.file'])
<mdr-file url="upload.php" model="model" data="{hola:'mundo'}" headers="{token:'shhh'}" size="5" limit="10" formats="'jpg,png,gif'" disabled="true" multiple="true" text="Arrastra o haz clic aquí"></mdr-file>
```

####API
#### API

######Attributes
###### Attributes

Attribute | Type | Description
--- | --- | ---
Expand All @@ -94,7 +94,7 @@ multiple | `boolean` | *If required to upload a multiple file is marked as true.
disabled | `boolean` | *If required disable the component is marked as true.*
text | `string` | *Text into area drag and drop.*

##How to contribute
## How to contribute

All contributions are very welcome, We love it. There are several ways to help out:

Expand All @@ -107,11 +107,11 @@ There are a few guidelines that we need contributors to follow so that we have a

If you want to making changes Better avoid working directly on the `master` branch, to avoid conflicts if you pull in updates from origin, so, if make your contribution under the branch [`dev`](https://github.com/Modulr/mdr-angular-file/tree/dev), into folder `src/`.

##Community
## Community

- Implementation help may be found at Stack Overflow (tagged [`mdr-file`](http://stackoverflow.com/questions/tagged/mdr-file)).

##Creators
## Creators

[@AlfredoBarronC](https://twitter.com/AlfredoBarronC)

Expand Down