1.0.0

CHANGELOG.md

@@ -1,3 +1,4 @@
-## [0.0.1] - TODO: Add release date.
-
-* TODO: Describe initial release.
+## 1.0.0
+* Support .properties
+* Support .json
+* Support .yaml

README.md

@@ -1,14 +1,42 @@
-# config_reader
+## What is config_reader
+A flutter library for reading config files online or offline.  
+[github](https://github.com/nnnggel/config_reader)
 
-A new Flutter project.
+## What format does config_reader support
+[.properties](https://en.wikipedia.org/wiki/.properties) 
+> readProperties  
+> readOnlineProperties  
 
-## Getting Started
+[.json](https://en.wikipedia.org/wiki/JSON)
+> readJson  
+> readOnlineJson
 
-This project is a starting point for a Dart
-[package](https://flutter.dev/developing-packages/),
-a library module containing code that can be shared easily across
-multiple Flutter or Dart projects.
+[.yaml](https://en.wikipedia.org/wiki/YAML)
+> readYaml  
+> readOnlineYaml
 
-For help getting started with Flutter, view our 
-[online documentation](https://flutter.dev/docs), which offers tutorials, 
-samples, guidance on mobile development, and a full API reference.
+## Result type
+All method will return a **MAP** for result. As json and yaml files are designed to support map or LIST as root, config_reader will add a root node for "list".
+
+For example:    
+json: 
+```
+[
+  "Cat",
+  "Dog",
+  "Goldfish"
+]
+```
+yaml:
+```
+- Cat
+- Dog
+- Goldfish
+```
+Will return:
+```
+{list: [Cat, Dog, Goldfish]}
+```
+
+## More case
+see test/config_reader_test.dart

lib/config_reader.dart

@@ -84,15 +84,9 @@ class ConfigReader {
 
 void main() {
   ConfigReader.readYaml("""
-languages:
- - Ruby
- - Perl
- - Python 
-websites:
- YAML: yaml.org
- Ruby: ruby-lang.org 
- Python: python.org 
- Perl: use.perl.org 
+- Cat
+- Dog
+- Goldfish
   """).then((value) {
     print(value);
   });

pubspec.yaml

@@ -1,8 +1,7 @@
 name: config_reader
-description: A new Flutter project.
-version: 0.0.1
-author:
-homepage:
+description: A flutter library for reading config files online or offline.
+version: 1.0.0
+homepage: https://github.com/nnnggel/config_reader
 
 environment:
   sdk: ">=2.7.0 <3.0.0"

test/config_reader_test.dart

@@ -1,5 +1,5 @@
-import 'package:config_reader/config_reader.dart';
 import 'package:flutter_test/flutter_test.dart';
+import 'package:config_reader/config_reader.dart';
 
 void main() {
   test('ConfigReader:readProperties', () async {
@@ -71,15 +71,15 @@ websites:
     expect(map2['list'][0], 'Cat');
   });
 
-  test('ConfigReader:readOnlineJson', () async {
+  test('ConfigReader:readOnlineYaml', () async {
     // map
-    Map<String, dynamic> map = await ConfigReader.readOnlineJson(
+    Map<dynamic, dynamic> map = await ConfigReader.readOnlineYaml(
         'https://raw.githubusercontent.com/nnnggel/config_reader/master/test/testfile/test_map.yaml');
     expect(map['websites']['YAML'], 'yaml.org');
     expect(map['languages'][0], 'Ruby');
 
     // list
-    Map<String, dynamic> map2 = await ConfigReader.readOnlineJson(
+    Map<dynamic, dynamic> map2 = await ConfigReader.readOnlineYaml(
         'https://raw.githubusercontent.com/nnnggel/config_reader/master/test/testfile/test_list.yaml');
     expect(map2['list'][0], 'Cat');
   });