diff --git a/CHANGELOG.md b/CHANGELOG.md index 0fad500..8e5783d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,10 @@ # Description of releases +## 3.0.0 (29-09-2017) +Features: +- Full code refactoring. +- Added testing system. +- Return to the callbacks and the rejection of Promise in favor of simplicity and lightness. + ## 2.1.0 (28-09-2017) Features: - The assembly system has been reworked, now the package is being assembled for use in browsers. diff --git a/README.md b/README.md index c673c29..629aac4 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,41 @@ # III Client -[](https://www.npmjs.com/package/iii-client) +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Connection to the service and retrieves the session identifier.
+Sends a message to bot and returns a response.
+Object
Answer from the server.
-
-**Rejects**: Error
If there are errors in operation.
+## connect(uuid, callback)
+Connection to the service and retrieves the session identifier.
| Param | Type | Description |
| --- | --- | --- |
-| uuid | String
| The bot ID. |
+| uuid | String
| Bot ID |
+| callback | function
| Function handler |
-#### send(cuid, text)
-Send a message to the server and return a response.
+
-**Promise**: Object
Answer from the server.
-
-**Rejects**: Error
If there are errors in operation.
+## send(cuid, text, callback)
+Sends a message to bot and returns a response.
| Param | Type | Description |
| --- | --- | --- |
-| cuid | String
| Session identifier. |
-| text | String
| Message text. |
-
-Found out a mistake or feel a lack of functionality?
-[issues](https://github.com/valentineus/iii-client/issues)
+| cuid | String
| Session ID |
+| text | String
| Send messages |
+| callback | function
| Function handler |
## License
[](https://github.com/eslint/eslint)
diff --git a/package.json b/package.json
index 3f03670..7165860 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "iii-client",
- "version": "2.1.0",
+ "version": "3.0.0",
"description": "Simple API for communicating with the bot of the \"iii.ru\" service.",
"homepage": "https://github.com/valentineus/iii-client",
"license": "MIT",