added minimal docs

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
-## 1.0.0
+## 0.1.0
 
-* Add changes here
+**ANDROID ONLY**
+
+* Implemented `AppAnalyser` that can collect, get extremum values and analyse following data:
+  * Battery Level
+  * Battery Temperature
+  * CPU Frequency
+  * CPU Temperature
+  * RAM Consumption
+  * Traffic Consumption
+* Implemented storages for analysis results
+  * `AnalysisMemoryStorage`
+  * `AnalysisFileStorage`
+* Implemented system data providers for:
+  * CPU Frequency
+  * CPU Temperature
+  * RAM Consumption

README.md

@@ -5,7 +5,7 @@
 ![GitHub](https://img.shields.io/github/license/marchdev-tk/app_analysis)
 ![GitHub stars](https://img.shields.io/github/stars/marchdev-tk/app_analysis?style=social)
 
-Package description
+Package that provides an ability to track device stats, including CPU/RAM/Battery/Traffic.
 
 ## Getting Started
 
@@ -20,3 +20,10 @@ Add examples here
 ## Feature requests and Bug reports
 
 Feel free to post a feature requests or report a bug [here](https://github.com/marchdev-tk/app_analysis/issues).
+
+## TODO
+
+* Add docs
+* Migrate to platform agnostic file operations
+* Remove external `battery_info` dependency in favour of custom data provider
+* Add interesting data based on analysis results in `AnalysisInfo` model

pubspec.yaml

@@ -3,7 +3,7 @@ version: 0.1.0
 homepage: https://github.com/marchdev-tk/app_analysis
 repository: https://github.com/marchdev-tk/app_analysis
 issue_tracker: https://github.com/marchdev-tk/app_analysis/issues
-description: app_analysis description
+description: Package that provides an ability to track device stats, including CPU/RAM/Battery/Traffic.
 
 environment:
   sdk: '>=2.18.6'

test/app_analysis_test.dart

@@ -1,4 +1,4 @@
-// Copyright (c) 2020, the MarchDev Toolkit project authors. Please see the AUTHORS file
+// Copyright (c) 2022, the MarchDev Toolkit project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
@@ -7,6 +7,6 @@ import 'package:flutter_test/flutter_test.dart';
 /// to run tests use `pub run test`
 void main() {
   test('test', () {
-    // TODO: Add tests here
+    // Add tests here
   });
 }