docs: update readme & contributing

Tabesto · Apr 22, 2021 · 18819e6 · 18819e6
1 parent 6e530e4
commit 18819e6
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 129 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,39 +2,7 @@
 
 If you want to contribute to the code, please follow the following rules.
 
-## Table of contents
-
-<!---
-ToC generated with https://ecotrust-canada.github.io/markdown-toc/
--->
-
-- [💻 Android Studio](#---android-studio)
-  * [Recommended plugins](#recommended-plugins)
-- [✏️ Code](#---code)
-  * [Clean code](#clean-code)
-  * [Code Style](#code-style)
-  * [Naming conventions](#naming-conventions)
-  * [Lint & Sonar](#lint---sonar)
-  * [Unit tests](#unit-tests)
-  * [UI](#ui)
-- [🛠 Tasks](#---tasks)
-  * [Git](#git)
-    + [Messages](#messages)
-    + [Branches](#branches)
-  * [App Versioning](#app-versioning)
-  * [Release a version](#release-a-version)
-  * [Markdown](#markdown)
-
-
-## 💻 Android Studio
 
-### Recommended plugins
-
-- [Adb Idea](https://plugins.jetbrains.com/plugin/7380-adb-idea) : Use ADB commands to your connected device directly from Android Studio.
-- [Kotlin Fill Class](https://plugins.jetbrains.com/plugin/10942-kotlin-fill-class) : Pre-fill all constructor parameters for a class. Essential for data classes.
-- [Key Promoter](https://plugins.jetbrains.com/plugin/9792-key-promoter-x) : Learn shortcuts for all actions done in Android Studio.
-- [String Manipulation](https://plugins.jetbrains.com/plugin/2162-string-manipulation) : Reformat strings (case switching, sorting, filtering, incrementing, aligning, encoding ...)
-- [Rainbow Brackets](https://plugins.jetbrains.com/plugin/10080-rainbow-brackets) : Increase readability for nested blocks.
 
 
 ## ✏️ Code
@@ -107,20 +75,12 @@ _After_ you commit, verify if tests are running on CI:
 
 
     ./gradlew clean createDebugCoverageReport
-    
+
 and open **jacoco report** generated in :
 
     /printer/build/reports/coverage/debug/index.html
 
 
-### UI
-
-Follow as much as possible the [Design System](https://uxdesign.cc/everything-you-need-to-know-about-design-systems-54b109851969) principles:
-
-- Create and re-use ui components with custom views
-- Use as much as possible `ConstrainLayout` to build responsive screens.
-- Create `styles`, `colors` and `dimens` instead of adding attributes in each views in layouts.
-
 
 ## 🛠 Tasks
 
@@ -154,18 +114,7 @@ cp .githooks/commit-msg .git/hooks/commit-msg
 
 Follow the [GitHub Flow][github-flow]
 
- 🚧 TODO update this.
-
-    ^(?:master|main|develop|feature\/(?P<feature_name>[A-Za-z][A-Za-z0-9\-\/]*)|(?:release|hotfix)\/(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:(?P<pre_release>(?:0|[1-9]\d*|\d*[A-Za-z-][A-Za-z0-9-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][A-Za-z0-9-]*))*))?(?:\+(?P<build_metadata>[A-Za-z0-9-]+(?:\.[A-Za-z0-9-]+)*))?)$
-
-
-### App Versioning
-
-Follow the [SemVer Conventions][semver]
-
-### Release a version
-
- 🚧 TODO explain release process with GitHub.
+Open a Pull Request targeting `develop` branch.
 
 ### Markdown
 
@@ -179,8 +128,6 @@ If you add or update titles, please generate a new Table of Contents by using [m
 
 
 
-
-[semver]: http://semver.org
 [conventional-commits]: https://www.conventionalcommits.org
 [github-flow]: https://guides.github.com/introduction/flow/
 [standard-version]: https://github.com/conventional-changelog/standard-version
diff --git a/README.md b/README.md
@@ -1,32 +1,9 @@
-# Tabesto printer module
-
-## Table of Contents
-<!---
-ToC generated with https://ecotrust-canada.github.io/markdown-toc/
--->
-
-- [Global architecture](#global-architecture)
-- [Installation](#installation)
-- [Usage](#usage)
-  * [Connect printer](#connect-printer)
-  * [Discover printers](#discover-printers)
-  * [Print ticket](#print-ticket)
-  * [Handle errors](#handle-errors)
-  * [...](#)
-- [Android architecture](#android-architecture)
-- [Continuous integration](#continuous-integration)
-  * [Build, tests, lints and sonar](#build--tests--lints-and-sonar)
-  * [Build, lints and sonar](#build--lints-and-sonar)
-  * [Publish library and prepare release](#publish-library-and-prepare-release)
-  * [Publish Javadoc](#publish-javadoc)
-- [Contributing](#contributing)
-- [License](#license)
-
-
-
-## Global architecture
+# Tabesto POS printer module
+
+## Description
 
 This module allows you to use POS printers easily with your Android application.
+With this wrapper module, we can handle printer(s) in a more convenient way, and add some flexibility.
 
 
 
@@ -38,75 +15,96 @@ This module allows you to use POS printers easily with your Android application.
 
 
 
-## Installation
-
-```api 'com.tabesto:printer-module:1.0.0-beta4'``` 🚧 TODO: update when first version will be released
+## Features
 
+- **Print** on **one** or **many** printer simultaneously.
+- **Customize ticket content** to print.
+- **Connect**, **disconnect** printers dynamically.
+- Retrieve printer **status** on demand.
+- **Discover** dynamically printers around (bluetooth only).
 
 
-## Usage
 
-See `sample` application
-
-🚧 TODO:
-
-### Connect printer
+## Installation
 
-### Discover printers
+Add it in your root build.gradle at the end of repositories:
 
-### Print ticket
+```groovy
+allprojects {
+		repositories {
+			...
+			maven { url 'https://jitpack.io' }
+		}
+	}
+```
 
-### Handle errors
 
-### ...
 
+Add the dependency in your module build.gradle, with the last version available [![](https://jitpack.io/v/Tabesto/android-pos-printer.svg)](https://jitpack.io/#Tabesto/android-pos-printer) :
 
+```groovy
+dependencies {
+  	...
+  	implementation 'com.github.Tabesto:android-pos-printer:{lastVersion}'
+	}
+```
 
-## Android architecture
 
-🚧 TODO
 
+## Logs
 
-## Continuous integration
-### Build, tests, lints and sonar
-A GitHubAction [android-tests](.github/workflows/android-tests.yml) is configured to build `printer` module on:
- - Pull request events : Open and Ready for review
- - Merge on develop branch
- - Demand
+If you want to see the library logs inside your application, just plant a [Timber Tree](https://github.com/JakeWharton/timber) :
 
-It follows these steps:
+```kotlin
+if (BuildConfig.DEBUG) {
+    Timber.plant(Timber.DebugTree())
+}
+```
 
-1. **Build** `printer` module
-2. Run **android lint** & **kotlin detekt** for `printer` & `sample` modules
-3. Run **instrumentation tests** for `printer` module
-4. Run **sonar** analyze (see [SonarCloud Project](https://sonarcloud.io/dashboard?id=Tabesto_pos-printer-module))
 
 
+## Usage
 
-### Build, lints and sonar
+See `sample` application.
 
-A GitHubAction [android-sonar](.github/workflows/android-sonar.yml) is configured to build `printer` module on:
+A [Javadoc is available here.](https://tabesto.github.io/android-pos-printer/printer/)
 
- - Pull request events : Open and Ready for review
- - Merge on develop branch
- - Demand
+🚧 TODO: add more detailed documentation with examples
 
-It follows these steps:
 
-1. **Build** `printer` module
-2. Run **android lint** & **kotlin detekt** for `printer` & `sample` modules
-3. Run **sonar** analyze (see [SonarCloud Project](https://sonarcloud.io/dashboard?id=Tabesto_pos-printer-module))
-4. Notify **slack** `mobile-ci` channel anyway
 
 
 ## Contributing
 
-If you want to contribute to the code, please refer to the following [CONTRIBUTING](CONTRIBUTING.md).
+All contributions are welcome ! If you want to contribute to the code, please refer to the following [CONTRIBUTING](CONTRIBUTING.md).
 
 If you want to modify diagrams present in this README, you can find all resources in `/docs/resources  ` directory. You can open xml file with [draw.io](https://draw.io/).
 
 
 
 ## License
 
-🚧 TODO: chose a public license when module will become public.
+```
+MIT License
+
+Copyright (c) 2021 TABESTO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
diff --git a/dependencies.gradle b/dependencies.gradle
@@ -9,7 +9,7 @@ ext.versions = [
         versionNameMinor               : 0,
         versionNamePatch               : 0,
         versionNamePreReleaseClassifier: "beta",
-        versionNamePreReleaseNumber    : null,
+        versionNamePreReleaseNumber    : 1,
         isSnapshot                     : false,
         buildTools                     : '30.0.2',
         androidGradleVersion           : '4.0.2',

diff --git a/docs/global-architecture-diagram.png b/docs/global-architecture-diagram.png
diff --git a/docs/resources/arch-modules-graphs.xml.xml b/docs/resources/arch-modules-graphs.xml.xml
@@ -1,2 +1 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<mxfile host="app.diagrams.net" modified="2020-10-12T14:27:33.529Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.121 Safari/537.36" etag="OifOIhF2IfrmJYhZEway" version="13.7.6" type="google" pages="2"><diagram id="I8E56uY5YPf1mQ0-Cvgx" name="Global architecture diagram">7Vhbd+MmEP41fqwPErrYj4njbU6brnPW2+22Lz1YwhINEirCt/31BQlsyciXJHb80uMHi9EwwHzfzDDqwVG2/pmjIv2NxZj2XBCve/Ch57qO5wbyT0k2tSQEw1qQcBJrpZ1gSn5gLQRauiAxLluKgjEqSNEWRizPcSRaMsQ5W7XV5oy2Vy1Qgi3BNELUlv5BYpHW0oEb7uSPmCSpWdkJ9PkyZJT1ScoUxWzVEMFxD444Y6J+ytYjTJXzjF/qeZ8OvN1ujONcnDPhRzFc0n9/ycAk+fZX/i3/nYvHn2BtZYnoQh9Yb1ZsjAc4W+QxVkZAD94zLlKWsBzRJ8YKKXSk8B8sxEZjhxaCSVEqMqrf4jUR3xvPfypTfdfXw4e1Nl0NNnpQCsTFnQJQCiKKypJERvyJ0K3tXPDNd2NADWrrvhnurFcjY74+JY4t8Hfe1KKSLXiEj7jQsBLxBIsjeu4WcxksmGVY7kfO45giQZbtfSDN2mSrtwNWPmhsX4GzZ8F6MSDD40C+FaEzCdBm5w1g9d8Jq576zIjcoQt04gx8nUZ02oQQtE3U+9Kz9six3cbb+eJYeeErmuFSMsIFz1wuirl8kul+Ifl0OGMohFYpEXhaoMrbK1kl2qSaSyxHjDJezYUzgCEOKqA5e8GNNwAPwGCgZrBcaI46ntKUtkmeqKG75cASc4HXx1lgo6YnwAFoed/19Hi1KwGOr2VpM/0DcBjpdwWwawEyfp5OPkvR9OFXG4GUZbNFedr7bagsn8+8wAeejdIcxSGKruL7wG0z3wmDvm95f9jh/OG1fO93FMmACk1F+Zyo58nXx/EXg0f9Wq7W1LgdTDEq0+10taWGkj9Wvw/BEjrw1lg69gVHlYupHuYsx1ZVeUOpPLN6HYLignVscGYdC295PRmcvoYWrKo646X0QGm8bK7UoMlxsA9FM1o0wHuB4gP1k3Iqqxx9ZiURhOUKOlyVOniv4oDItuBpT2HGhGBZQ+GOkkS9EIop92whKMnl6qY7UYsgrbI1Ls9RqGNm60R1UX02n5MI92O8lH9lv9AF9yIx6YB2TLpBV371AzsmvfBaMQlOw5/IkCwOHl93f2hm1MFr3eLCPbfALreEnTX/Wn4J/4+KI1FBChT/nZGcnBsXR7hn0+JmoA9Pg97CtNOXDaAtt14azH2YVnhGZbUs+yiPOVNn3efVnTe6k+HWScKLA2nMhCaczV3EVZ3rfoBDvyPvOWbq5TOfY4F7jdvIlXvwD7jFhGfeYg4k+Y+5xTheR+zWnYC8W+emDfjMVKNPsoLiTMVerEiJRaNpaGpbBDHxljOBT3cOMxS9JBWBJnWi0PIY8ZeJuvCLCuw+UFyIWKYArrBvxqwpD43G2z2Cu53Jt53FYDd6wnOFZKOD/6JjrhLpdUBXv7PHsHfdh0LY7vUhdPqmSWgkhoFjJwbf26aQV3BJDncffevvNbtP53D8Hw==</diagram><diagram id="dOeniJY8UBM9NAr1NG8j" name="Android architecture">zVbZcpswFP0aZtwHzxjw0j4GkzTpZOu4mS5vMlxAsZCIEF7y9b1CYrMnnTYPHb+AdHR1dO8RSMfxl/n+syRFdidiYI43ifeOHzqe5069Ob40cjDIYjEzQCppbIM6YEVfwYITi1Y0hnIQqIRgihZDMBKcQ6QGGJFS7IZhiWDDVQuSwgmwigg7Rb/TWGUG/egtOvwaaJo1K7vzT2YkJ02wraTMSCx2Pci/dPylFEKZVr5fAtPiNbrMo62ffP31NCOP4svtdvy4ub8fG7Krf5nSliCBq3dTr35wz108PwV899N/eBE3oZfYKZMtYZXVy/HmDBcJCl2xOlgZ5y+VLjPIiUwpd/wLHJ0Ue3wiWIul8bEShRmb9sYU7NWYMJraeRFWAbLjxFZq3/XKtAeQHAkDdtq70RwJiaCFh1MGjCgKPV5lLU+QBniU1GbYzF4fxyJWHGOZ1JI1P0BTnft2oe+SmEGiehq/xX1a3hmn3G0bX5f6RTlVFD+ZV7B78bB+xsNh9OFPxfyn3EpQNqlbWirgIEfFsG/4joLOIXV7xtrMRoKvqiiCskwqZrGliaDCLqsVn4yP/6rJE+7PORRUCx8SRc7iy4hpeaTwOWSF3+s3Gm3A6KTapmHphtpc+0fHCRsjFY+yUFe6BXkYoV0ghzvKGC0N4a3gaZ10qAs4CwHwVuoSfiMjb5CLh6GoFGEX5toK64stsJdYaHIINGHCakuwM9YiSARX1gO5nu1fkZwy7Z6ugW1B0+qTV+VMB9V/ZU4jbOs6SaWEPY91V4LuNL7FbZHWsWiI5j1v400R2WVUwarQtyOmhr6u3rg1sIBEm1SKisdLwQQeVCEXHFoBdNXQOL+/NB1u64TQQoLIQckDzrMs3sw6DOsecUtNf9d5MX9qsaznw1r/SKz/S1vuzuNgw9qcptu5sXqs52n9y98=</diagram></mxfile>
+<mxfile host="Electron" modified="2021-04-21T17:09:50.381Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.5.1 Chrome/89.0.4389.82 Electron/12.0.1 Safari/537.36" etag="MAAsJOm0AOwTiwHXAa9w" version="14.5.1" type="device" pages="2"><diagram id="I8E56uY5YPf1mQ0-Cvgx" name="Global architecture diagram">7Vlbc9o4FP41PNYjW74+JoS2s8k2zJDtNvvSEbawtStbrixu/fUrYdn4FmATKLMzgRnwObr46HzfJx3MCI7TzSeO8uR3FmE6skC0GcG7kWUFtis/lWNbOlwblI6Yk6h0mXvHjPzE2ll1W5IIF62OgjEqSN52hizLcChaPsQ5W7e7LRht3zVHMe45ZiGife+fJBJJ6fUtb+//jEmcVHc23aBsSVHVWa+kSFDE1g0XnIzgmDMmyqt0M8ZU5a7KSznu4wutdWAcZ+KUAT/zYEV//JaCx/jrX9nX7A8uPn/Qs6wQXeoFjyyXyvluF0xOq/JKGd+1uD+WKtTbkQUBsMMgaLrcWH0/oTkuBJPDpo8z9clJJjCXV5IXS5lSPbcMspy+HKbzI7ZV0jlbZhFWcZuyeZ0QgWc5ClXrWrJM+hKRUt28IJSO6yjhHGCIXekvBGf/4EYLwD7wfb00zTTTVj3l3CSLlSlRuUWUxJk0QrwLHt6uMBdEUuJGNwiW11E3818lU3bHm4ZL4/EJsxQLvpVddKvlaW5ocdSsX++pZlWCSZo0c7UTaXrH9dx7BsgLTYJhQsyQ+f1+608xo89Pm3v28PRl/ME6AAaQq2ZcJCxmGaIPTKVhB8HfWIitzihaSgK0ACoE4uJGaVEllaKiIGHl/kho1Q1viPim7mIEZmU/72zoWdq+2+gwdsa2YUwxJzIDCq+dr1wGjnrq7sFVsCUP8QGN6JTIcGMsDqTuBaw5pkiQVTuOt+B2KMj/KOQgsEMA+kKeTGePX+Sg2d39yZpNWDpfFsf12hZ3T6Vz23WA3df1AkUeCvtqPYMMoe20Zei4htMTYjCgw+AMMhzel/s6VFyeaTNjGW6l8rLSVMA3oHAm6q2El8m1fqv0q4znSpLK2Kt1Z1Vyfb0S/b4SD4mho/5rSdMfkGYH25ztDsrJSqakqLCp6gWVswgVSQ10C8CmfDQtOspxgHpLP5XHM52yggjCBg+4h06HOROCpS+egGwpKMnk3avSCwydnnIduVpmuolVhWiwxYKE2IjwSn4VRq5rhLMo2YXtA9V0zQElO25fybZ3KSWD4/DHUsj56cuvq100r2YAB9Pid8oMOLS/eUN1BrhUWrx3URwQBclR9D0lGRmUxWGeHRfL1UAPjoPewnQwlw2ge2k9N5hdmNZ4TuURWxgoizhTa+3y6sYe38BgmIRnB7Jq9Yx2AQMtw+sLHDoD2169P55/4zN74F6ihKlrkLrQKH80OEeqkDeWPq8vYrwTixjzWkXMyz9u3vfrE4uYgSO7R5WTixgL/soiZhB9+I7+1dAPgmujb7+jfy30oXd17Ts9sH/9E0HfD1pPBF3g/h+eCMI3nth66FSJa88R2+5wxOw8hSrj16Oa/wh0JvLMoL3V2MAAwAI+1C+3PW+53t68O1bVy3s90dyrE6352Nk8SLArkMm+CJkcDxqB36aBFxhB82W/kl7AM4DVntqHhuvbjg1s3/Wh45yJYNLc/5FWdt//Gwkn/wI=</diagram><diagram id="dOeniJY8UBM9NAr1NG8j" name="Android architecture">zVbZcpswFP0aZtwHzxjw0j4GkzTpZOu4mS5vMlxAsZCIEF7y9b1CYrMnnTYPHb+AdHR1dO8RSMfxl/n+syRFdidiYI43ifeOHzqe5069Ob40cjDIYjEzQCppbIM6YEVfwYITi1Y0hnIQqIRgihZDMBKcQ6QGGJFS7IZhiWDDVQuSwgmwigg7Rb/TWGUG/egtOvwaaJo1K7vzT2YkJ02wraTMSCx2Pci/dPylFEKZVr5fAtPiNbrMo62ffP31NCOP4svtdvy4ub8fG7Krf5nSliCBq3dTr35wz108PwV899N/eBE3oZfYKZMtYZXVy/HmDBcJCl2xOlgZ5y+VLjPIiUwpd/wLHJ0Ue3wiWIul8bEShRmb9sYU7NWYMJraeRFWAbLjxFZq3/XKtAeQHAkDdtq70RwJiaCFh1MGjCgKPV5lLU+QBniU1GbYzF4fxyJWHGOZ1JI1P0BTnft2oe+SmEGiehq/xX1a3hmn3G0bX5f6RTlVFD+ZV7B78bB+xsNh9OFPxfyn3EpQNqlbWirgIEfFsG/4joLOIXV7xtrMRoKvqiiCskwqZrGliaDCLqsVn4yP/6rJE+7PORRUCx8SRc7iy4hpeaTwOWSF3+s3Gm3A6KTapmHphtpc+0fHCRsjFY+yUFe6BXkYoV0ghzvKGC0N4a3gaZ10qAs4CwHwVuoSfiMjb5CLh6GoFGEX5toK64stsJdYaHIINGHCakuwM9YiSARX1gO5nu1fkZwy7Z6ugW1B0+qTV+VMB9V/ZU4jbOs6SaWEPY91V4LuNL7FbZHWsWiI5j1v400R2WVUwarQtyOmhr6u3rg1sIBEm1SKisdLwQQeVCEXHFoBdNXQOL+/NB1u64TQQoLIQckDzrMs3sw6DOsecUtNf9d5MX9qsaznw1r/SKz/S1vuzuNgw9qcptu5sXqs52n9y98=</diagram></mxfile>
diff --git a/printer/src/main/AndroidManifest.xml b/printer/src/main/AndroidManifest.xml
@@ -1,11 +1,9 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.tabesto.printer">
 
-    <uses-permission android:name="android.permission.BLUETOOTH"/>
-    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
-    <uses-permission android:name="android.permission.INTERNET"/>
-    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
-    <uses-permission
-        android:name="android.permission.ACCESS_COARSE_LOCATION"/>
+    <uses-permission android:name="android.permission.BLUETOOTH" />
+    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
 
 </manifest>