Skip to content

Commit 20a32b1

Browse files
committed
Add readme
1 parent 27c1b20 commit 20a32b1

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Asana for Laravel
2+
3+
[![Latest Stable Version](https://poser.pugx.org/torann/laravel-asana/v/stable.png)](https://packagist.org/packages/torann/laravel-asana) [![Total Downloads](https://poser.pugx.org/torann/laravel-asana/downloads.png)](https://packagist.org/packages/torann/laravel-asana)
4+
5+
----------
6+
7+
## Installation
8+
9+
- [Laravel Asana on Packagist](https://packagist.org/packages/torann/laravel-asana)
10+
- [Laravel Asana on GitHub](https://github.com/torann/laravel-asana)
11+
12+
To get the latest version of Laravel Asana simply require it in your `composer.json` file.
13+
14+
~~~
15+
"torann/laravel-asana": "0.1.*@dev"
16+
~~~
17+
18+
You'll then need to run `composer install` to download it and have the autoloader updated.
19+
20+
### Create configuration file using artisan
21+
22+
```
23+
$ php artisan config:publish torann/laravel-asana
24+
```
25+
26+
## Quick Examples
27+
28+
#### Creating a task
29+
30+
```php
31+
Asana::createTask(array(
32+
'workspace' => '176825', // Workspace ID
33+
'name' => 'Hello World!', // Name of task
34+
'assignee' => '[email protected]', // Assign task to...
35+
'followers' => array('3714136', '5900783') // We add some followers to the task... (this time by ID)
36+
));
37+
```
38+
39+
#### Adding task to project
40+
41+
```php
42+
Asana::addProjectToTask(:task_id, :project_id);
43+
```
44+
45+
#### Commenting on a task
46+
47+
```php
48+
Asana::commentOnTask(:task_id, 'Please please! Don't assign me this task!');
49+
```
50+
51+
#### Getting projects in all workspaces
52+
53+
```php
54+
Asana::getProjects();
55+
```
56+
57+
#### Updating project info
58+
59+
```php
60+
Asana::updateProject(:project_id, array(
61+
'name' => 'This is a new cool project!',
62+
'notes' => 'At first, it wasn't cool, but after this name change, it is!'
63+
));
64+
```
65+
66+
## Full Documentation
67+
68+
[View the official documentation](https://github.com/Torann/laravel-asana/wiki).

0 commit comments

Comments
 (0)