Merge pull request #3 from chaplean/feature/tag-v1.0.0

update README, composer and CHANGELOG for v1.0.0

Api/KanbanizeApiV1.php

@@ -20,7 +20,7 @@
  * @method Route postTaskDetails()        Get details for one task    ( https://kanbanize.com/api/#get_task_details )
  * @method Route postTasksDetails()       Get details for many task   ( https://kanbanize.com/api/#get_task_details )
  * @method Route postAllTasks()           Get all tasks for one board ( https://kanbanize.com/api/#get_all_tasks )
- * @method Route postLogTimeActivities()  Create a new task           ( https://kanbanize.com/api/#get_log_time_activities )
+ * @method Route postLogTimeActivities()  Get log time activities     ( https://kanbanize.com/api/#get_log_time_activities )
  *
  * @package   Chaplean\Bundle\KanbanizeApiClientBundle\Api
  * @author    Valentin - Chaplean <valentin@chaplean.coop>

CHANGELOG.md

@@ -1,13 +1,32 @@
 # Changelog
 
-## x.y.z
+## v1.0.0
 
 Breaking changes:
-	* …
-
+    **None**
+    
 New features:
-	* Kanbanize API V1 (partial) implementation
-	* Kanbanize API V2 (partial) implementation
-
+* Partial implementation of the version 1 and 2 of Kanbanize API
+    * For version 1 API, you can:
+        * Get projects and boards
+        * Get board structure
+        * Get full board structure
+        * Get board settings
+        * Get board activities
+        * Create a new task
+        * Get details for one task 
+        * Get details for many task
+        * Get all tasks for one board
+        * Get log time activities
+    * For version 2 API, you can:
+        * Get a list of child cards
+        * Make a card a child of a given card 
+        * Get a list of parent cards
+        * Make a card a parent of a given card 
+        * Get a list of predecessor cards
+        * Make a card a predecessor of a given card 
+        * Get a list of successor cards
+        * Make a card a successor of a given card 
+
 Bug fixes:
-	* …
+    **None**

README.md

@@ -1,9 +1,7 @@
-# ⚠ Bundle in progress ⚠
-
 # ChapleanKanbanizeApiClientBundle
 
-> CI Badges. [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/chaplean/kanbanize-api-client-bundle/issues)
-
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/chaplean/kanbanize-api-client-bundle/issues)
+[![Coverage Status](https://coveralls.io/repos/github/chaplean/kanbanize-api-client-bundle/badge.svg?branch=master)](https://coveralls.io/github/chaplean/kanbanize-api-client-bundle?branch=master)
 
 
 ## Table of content
@@ -18,30 +16,26 @@
 
 ## Installation
 
-> Instructions to install the project. For bundles it might be something along the lines of:
-
-You can use [composer](https://getcomposer.org) to install [projectname]:
+You can use [composer](https://getcomposer.org) to install this:
 ```bash
 composer require chaplean/kanbanize-api-client-bundle
 ```
 
 ## Configuration
 
-#### Define parameters
-
-In your `parameters.yml`
+Define parameters in your `parameters.yml`
 
 ```yaml
-chaplean_kanbanize_api_v1.url: 'kanbanize url api (v1)'
-chaplean_kanbanize_api_v2.url: 'kanbanize url api (v2)'
-chaplean_kanbanize_api.apikey: 'your apikey'
+chaplean_kanbanize_api.apikey: 'your apikey' # A default apikey of an kanbanize user
+chaplean_kanbanize_api_v1.url: 'kanbanize url api v1' # Probably: https://<your team>.kanbanize.com/index.php/api/kanbanize/
+chaplean_kanbanize_api_v2.url: 'kanbanize url api v2' # Probably: https://<your team>.kanbanize.com/api/v2/
 ```
 
 ## Usage
 
 You can use 2 versions of the API.
 
-Version 1: `KanbanizeApiV1` (see: https://kanbanize.com/api)
+**Version 1**: `KanbanizeApiV1` (see: https://kanbanize.com/api)
 
 Available routes:
 
@@ -56,9 +50,9 @@ Available routes:
 | postTaskDetails()        | Get details for one task    |
 | postTasksDetails()       | Get details for many task   |
 | postAllTasks()           | Get all tasks for one board |
-| postLogTimeActivities()  | Create a new task           |
+| postLogTimeActivities()  | Get log time activities     |
 
-Version 2 (beta): `KanbanizeApiV2` (see: https://\<your team>.kanbanize.com/openapi/#/)
+**Version 2** (beta): `KanbanizeApiV2` (see: https://\<your team>.kanbanize.com/openapi/#/)
 
 Available functions:
 
@@ -95,8 +89,6 @@ As a reminder, all contributors are expected to follow our [Code of Conduct](COD
 
 ## Hacking
 
-> When applicable describe how to perform various common actions when working on the project. For example:
-
 You might find the following commands usefull when hacking on this project:
 
 ```bash

composer.json

@@ -22,7 +22,6 @@
     "require": {
         "php": ">=7.1",
         "symfony/config": "^3.0 || ^4.0",
-        "symfony/console": "^3.0 || ^4.0",
         "symfony/dependency-injection": "^3.0 || ^4.0",
         "symfony/yaml": "^3.0 || ^4.0",
         "chaplean/api-client-bundle": "^1.1"
@@ -31,7 +30,7 @@
         "chaplean/coding-standard": "^1.1",
         "mockery/mockery": "^1.2",
         "php-coveralls/php-coveralls": "^2.1",
-        "phpunit/phpunit": "^7.0",
+        "phpunit/phpunit": "^5.0 || ^6.0 || ^7.0 || ^8.0",
         "symfony/http-kernel": "^2.8 || ^3.0 || ^4.0",
         "symfony/var-dumper": "^2.8 || ^3.0 || ^4.0"
     },