From 89b0e9658c18a66b705ec5d1e6fed1e628697285 Mon Sep 17 00:00:00 2001 From: Vitus Date: Tue, 10 Mar 2020 13:55:11 +0100 Subject: [PATCH] Improve README (snapshot versions) (#277) --- README.md | 31 ++++++++++++++++++++++++++++--- example/README.md | 6 ++++-- floor/README.md | 31 ++++++++++++++++++++++++++++--- floor_annotation/README.md | 8 ++++++-- floor_generator/README.md | 6 ++++-- 5 files changed, 70 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f8673f44..79b59c2f 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This package is still in an early phase and the API will likely change. [![build status](https://github.com/vitusortner/floor/workflows/Continuous%20integration/badge.svg)](https://github.com/vitusortner/floor/actions) [![codecov](https://codecov.io/gh/vitusortner/floor/branch/develop/graph/badge.svg)](https://codecov.io/gh/vitusortner/floor) -### Table of contents +### Table of Contents 1. [Quick Start](#quick-start) 1. [Architecture](#architecture) @@ -28,6 +28,7 @@ This package is still in an early phase and the API will likely change. 1. [Callback](#callback) 1. [Testing](#testing) 1. [Examples](#examples) +1. [Snapshot Version](#snapshot-version) 1. [Naming](#naming) 1. [Bugs and Feedback](#bugs-and-feedback) 1. [License](#license) @@ -473,7 +474,7 @@ Their usage can be seen in the following snippet. ```dart final callback = Callback( onCreate: (database, version) { /* database has been created */ }, - onOpen: (database) { /* database has been opened */}, + onOpen: (database) { /* database has been opened */ }, onUpgrade: (database, startVersion, endVersion) { /* database has been upgraded */ }, ); @@ -556,9 +557,33 @@ void main() { ## Examples For further examples take a look at the [example](https://github.com/vitusortner/floor/tree/develop/example) and [test](https://github.com/vitusortner/floor/tree/develop/floor/test/integration) directories. + +## Snapshot Version +In case you want to play with the most recent changes that haven't been released to pub yet, apply following changes to your `pubspec.yaml`. + +```yaml +dependencies: + flutter: + sdk: flutter + floor: + git: + url: git://github.com/vitusortner/floor.git + ref: develop + path: floor + +dev_dependencies: + floor_generator: + git: + url: git://github.com/vitusortner/floor.git + ref: develop + path: floor_generator + build_runner: ^1.7.3 +``` ## Naming -*Floor - the bottom layer of a [Room](https://developer.android.com/topic/libraries/architecture/room).* +The library's name derives from the following. +*Floor* as the *bottom layer* of a [Room](https://developer.android.com/topic/libraries/architecture/room) which points to the analogy of the database layer being the bottom and foundation layer of most applications. +Where *fl* also gives a pointer that the library is used in the Flutter context. ## Bugs and Feedback For bugs, questions and discussions please use the [Github Issues](https://github.com/vitusortner/floor/issues). diff --git a/example/README.md b/example/README.md index 9a815cd0..2ad46472 100644 --- a/example/README.md +++ b/example/README.md @@ -1,11 +1,13 @@ # Floor -**A supportive SQLite abstraction for your Flutter applications.** +**A supportive SQLite abstraction for your Flutter applications (iOS, Android and macOS)** This is an example on how to use the library. --- -*Floor - the bottom layer of a [Room](https://developer.android.com/topic/libraries/architecture/room).* +The library's name derives from the following. +*Floor* as the *bottom layer* of a [Room](https://developer.android.com/topic/libraries/architecture/room) which points to the analogy of the database layer being the bottom and foundation layer of most applications. +Where *fl* also gives a pointer that the library is used in the Flutter context. ## Bugs and Feedback For bugs, questions and discussions please use the [Github Issues](https://github.com/vitusortner/floor/issues). diff --git a/floor/README.md b/floor/README.md index f8673f44..79b59c2f 100644 --- a/floor/README.md +++ b/floor/README.md @@ -9,7 +9,7 @@ This package is still in an early phase and the API will likely change. [![build status](https://github.com/vitusortner/floor/workflows/Continuous%20integration/badge.svg)](https://github.com/vitusortner/floor/actions) [![codecov](https://codecov.io/gh/vitusortner/floor/branch/develop/graph/badge.svg)](https://codecov.io/gh/vitusortner/floor) -### Table of contents +### Table of Contents 1. [Quick Start](#quick-start) 1. [Architecture](#architecture) @@ -28,6 +28,7 @@ This package is still in an early phase and the API will likely change. 1. [Callback](#callback) 1. [Testing](#testing) 1. [Examples](#examples) +1. [Snapshot Version](#snapshot-version) 1. [Naming](#naming) 1. [Bugs and Feedback](#bugs-and-feedback) 1. [License](#license) @@ -473,7 +474,7 @@ Their usage can be seen in the following snippet. ```dart final callback = Callback( onCreate: (database, version) { /* database has been created */ }, - onOpen: (database) { /* database has been opened */}, + onOpen: (database) { /* database has been opened */ }, onUpgrade: (database, startVersion, endVersion) { /* database has been upgraded */ }, ); @@ -556,9 +557,33 @@ void main() { ## Examples For further examples take a look at the [example](https://github.com/vitusortner/floor/tree/develop/example) and [test](https://github.com/vitusortner/floor/tree/develop/floor/test/integration) directories. + +## Snapshot Version +In case you want to play with the most recent changes that haven't been released to pub yet, apply following changes to your `pubspec.yaml`. + +```yaml +dependencies: + flutter: + sdk: flutter + floor: + git: + url: git://github.com/vitusortner/floor.git + ref: develop + path: floor + +dev_dependencies: + floor_generator: + git: + url: git://github.com/vitusortner/floor.git + ref: develop + path: floor_generator + build_runner: ^1.7.3 +``` ## Naming -*Floor - the bottom layer of a [Room](https://developer.android.com/topic/libraries/architecture/room).* +The library's name derives from the following. +*Floor* as the *bottom layer* of a [Room](https://developer.android.com/topic/libraries/architecture/room) which points to the analogy of the database layer being the bottom and foundation layer of most applications. +Where *fl* also gives a pointer that the library is used in the Flutter context. ## Bugs and Feedback For bugs, questions and discussions please use the [Github Issues](https://github.com/vitusortner/floor/issues). diff --git a/floor_annotation/README.md b/floor_annotation/README.md index b21c9a91..1cc13685 100644 --- a/floor_annotation/README.md +++ b/floor_annotation/README.md @@ -1,11 +1,15 @@ # Floor -**A supportive SQLite abstraction for your Flutter applications.** +**A supportive SQLite abstraction for your Flutter applications (iOS, Android and macOS)** Don't import this package! You should be using the [floor](https://pub.dartlang.org/packages/floor) package, which comes with all the annotations. Separating the packages brings some benefits for developing the library but not for the users of it. -*Floor - the bottom layer of a [Room](https://developer.android.com/topic/libraries/architecture/room).* +--- + +The library's name derives from the following. +*Floor* as the *bottom layer* of a [Room](https://developer.android.com/topic/libraries/architecture/room) which points to the analogy of the database layer being the bottom and foundation layer of most applications. +Where *fl* also gives a pointer that the library is used in the Flutter context. ## Bugs and Feedback For bugs, questions and discussions please use the [Github Issues](https://github.com/vitusortner/floor/issues). diff --git a/floor_generator/README.md b/floor_generator/README.md index 937d4de7..63dc1d95 100644 --- a/floor_generator/README.md +++ b/floor_generator/README.md @@ -1,12 +1,14 @@ # Floor -**A supportive SQLite abstraction for your Flutter applications.** +**A supportive SQLite abstraction for your Flutter applications (iOS, Android and macOS)** This is the dev dependency and contains the annotation processor. Please refer to the [floor](https://pub.dartlang.org/packages/floor) package on pub or visit [Github](https://github.com/vitusortner/floor) for more information. --- -*Floor - the bottom layer of a [Room](https://developer.android.com/topic/libraries/architecture/room).* +The library's name derives from the following. +*Floor* as the *bottom layer* of a [Room](https://developer.android.com/topic/libraries/architecture/room) which points to the analogy of the database layer being the bottom and foundation layer of most applications. +Where *fl* also gives a pointer that the library is used in the Flutter context. ## Bugs and Feedback For bugs, questions and discussions please use the [Github Issues](https://github.com/vitusortner/floor/issues).