Skip to content

Commit

Permalink
GitBook: [develop] 60 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
agrosner authored and gitbook-bot committed Oct 21, 2018
1 parent 252a388 commit cfc5d46
Show file tree
Hide file tree
Showing 35 changed files with 584 additions and 1,108 deletions.
2 changes: 2 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# .github

19 changes: 7 additions & 12 deletions .github/CONTRIBUTING.md → .github/contributing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Contributing Guidelines
--------------------------------------------------
# CONTRIBUTING

## Contributing Guidelines

This document provides general guidelines about how to contribute to the project. Keep in mind these important things before you start contributing.

Expand All @@ -8,23 +9,17 @@ This document provides general guidelines about how to contribute to the project
* Use [github issues](https://github.com/agrosner/DBFlow/issues) to report a bug.
* Before creating a new issue:
* Make sure you are using the [latest release](https://github.com/agrosner/DBFlow/releases).
* Check if the issue was [already reported or fixed](https://github.com/agrosner/DBFlow/issues?utf8=%E2%9C%93&q=is%3Aissue). Notice that it may not be released yet.
* Check if the issue was [already reported or fixed](https://github.com/agrosner/DBFlow/issues?utf8=&q=is%3Aissue). Notice that it may not be released yet.
* If you found a match add the github "+1" reaction brief comment. This helps prioritize the issues addressing the most common and critical ones first. If possible, add additional information to help us reproduce, and find the issue. Please use your best judgement.
* Reporting issues:
* Please include the following information to help maintainers to fix the problem faster:
* Android version you are targeting.
* Full console output of stack trace or code compilation error.
* Any other additional detail you think it would be useful to understand and solve the problem.


## Pull requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request: 1. Match coding style \(braces, spacing, etc.\) This is best achieved using CMD+Option+L \(Reformat code\) on Mac \(not sure for Windows\) with Android Studio defaults. 2. If its a feature, bugfix, or anything please only change code to what you specify. 3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :\) 4. Pull requests _must_ be made against `develop` branch. Any other branch \(unless specified by the maintainers\) will get rejected.

### Suggested git workflow to contribute

Expand All @@ -39,12 +34,12 @@ I welcome and encourage all pull requests. It usually will take me within 24-48
9. Push your branch into your forked remote repository.
10. Create a new pull request adding any useful comment.


### Feature proposal

We would love to hear your ideas and make discussions about it.

* Use github issues to make feature proposals.
* We use `type: feature request` label to mark all [feature request issues](https://github.com/agrosner/DBFlow/labels/type%3A%20feature%20request).
* Before submitting your proposal make sure there is no similar feature request. If you find a match, feel free to join the discussion or just or just act with a reaction if you think the feature is worth implementing.
* Be as specific as possible providing a precise explanation of the feature so anyone can understand the problem and the benefits of solving it.
* Be as specific as possible providing a precise explanation of the feature so anyone can understand the problem and the benefits of solving it.

35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# README

![Image](https://github.com/agrosner/DBFlow/blob/develop/dbflow_banner.png?raw=true)

[![JitPack.io](https://img.shields.io/badge/JitPack.io-5.0.0alpha1-red.svg?style=flat)](https://jitpack.io/#Raizlabs/DBFlow) [![Android Weekly](http://img.shields.io/badge/Android%20Weekly-%23129-2CB3E5.svg?style=flat)](http://androidweekly.net/issues/issue-129) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-DBFlow-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/1134)

DBFlow is fast, efficient, and feature-rich Kotlin database library built on SQLite for Android. DBFlow utilizes annotation processing to generate SQLite boilerplate for you and provides a powerful SQLite query language that makes using SQLite a joy.

DBFlow is built from a collection of some of the best features of many database libraries. Don't let an ORM or library get in your way, let the code you write in your applications be the best as possible.
DBFlow is built from a collection of some of the best features of many database libraries. Don't let an ORM or library get in your way, let the code you write in your applications be the best as possible.

Supports:

Expand All @@ -18,20 +20,21 @@ Supports:

**SQLCipher:** Easy database encryption support in this library.

**SQLite Query Language:** Enabling autocompletion on sqlite queries combined with Kotlin language features means SQLite-like syntax.
**SQLite Query Language:** Enabling autocompletion on sqlite queries combined with Kotlin language features means SQLite-like syntax.

# Changelog
## Changelog

Changes exist in the [releases tab](https://github.com/Raizlabs/DBFlow/releases).

# Usage Docs
## Usage Docs

For more detailed usage, check out it out [here](https://agrosner.gitbooks.io/dbflow/content/)

# Including in your project
## Including in your project

Add jitpack.io to your project's repositories:
```groovy

```groovy
allProjects {
repositories {
google()
Expand All @@ -45,7 +48,6 @@ allProjects {
Add artifacts to your project:

```groovy
apply plugin: 'kotlin-kapt' // only required for kotlin consumers.
def dbflow_version = "5.0.0-alpha1"
Expand All @@ -60,7 +62,7 @@ Add artifacts to your project:
// if only using Java, use this. If using Kotlin do NOT use this.
annotationProcessor "com.github.agrosner.dbflow:processor:${dbflow_version}"
// core set of libraries
compile "com.github.agrosner.dbflow:core:${dbflow_version}"
compile "com.github.agrosner.dbflow:lib:${dbflow_version}"
Expand All @@ -82,18 +84,15 @@ Add artifacts to your project:
compile "com.github.agrosner.dbflow:contentprovider:${dbflow_version}"
}
```

# Pull Requests
I welcome and encourage all pull requests. Here are some basic rules to follow to ensure timely addition of your request:
1. Match coding style (braces, spacing, etc.) This is best achieved using **Reformat Code** shortcut, <kbd>command</kbd>+<kbd>option</kbd>+<kbd>L</kbd> on Mac and <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>L</kbd> on Windows, with Android Studio defaults.
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get **rejected**.
5. Have fun!
## Pull Requests

I welcome and encourage all pull requests. Here are some basic rules to follow to ensure timely addition of your request: 1. Match coding style \(braces, spacing, etc.\) This is best achieved using **Reformat Code** shortcut, command+option+L on Mac and Ctrl+Alt+L on Windows, with Android Studio defaults. 2. If its a feature, bugfix, or anything please only change code to what you specify. 3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :\) 4. Pull requests _must_ be made against `develop` branch. Any other branch \(unless specified by the maintainers\) will get **rejected**. 5. Have fun!

## Maintainer

# Maintainer
Originally created by [Raizlabs](https://www.raizlabs.com), a [Rightpoint](https://www.rightpoint.com) company

Maintained by [agrosner](https://github.com/agrosner) ([@agrosner](https://www.twitter.com/agrosner))
Maintained by [agrosner](https://github.com/agrosner) \([@agrosner](https://www.twitter.com/agrosner)\)

35 changes: 35 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Table of contents

* [README](README.md)
* [README](usage2/README.md)
* [Including In Project](usage2/including-in-project.md)
* [Proguard](usage2/proguard.md)
* [Usage](usage2/usage/README.md)
* [Databases](usage2/usage/databases.md)
* [Models](usage2/usage/models.md)
* [Migrations](usage2/usage/migrations.md)
* [Views](usage2/usage/modelviews.md)
* [Relationships](usage2/usage/relationships.md)
* [Storing Data](usage2/usage/storingdata.md)
* [Retrieval](usage2/usage/retrieval.md)
* [SQLite Query Language](usage2/usage/sqlitewrapperlanguage.md)
* [TypeConverters](usage2/usage/typeconverters.md)
* [Observability](usage2/usage/observability.md)
* [RXJavaSupport](usage2/rxjavasupport.md)
* [Advanced Usage](usage2/advanced-usage/README.md)
* [Caching](usage2/advanced-usage/caching.md)
* [ListBasedQueries](usage2/advanced-usage/listbasedqueries.md)
* [MultipleModules](usage2/advanced-usage/multiplemodules.md)
* [QueryModels](usage2/advanced-usage/querymodels.md)
* [Indexing](usage2/advanced-usage/indexing.md)
* [SQLCipher](usage2/advanced-usage/sqlciphersupport.md)
* [ContentProviderGeneration](usage2/contentprovidergeneration.md)
* [GettingStarted](usage2/gettingstarted.md)
* [Migration3Guide](usage2/migration3guide.md)
* [Migration4Guide](usage2/migration4guide.md)
* [KotlinSupport](usage2/kotlinsupport.md)
* [SUMMARY](usage2/summary.md)
* [ISSUE\_TEMPLATE](issue_template.md)
* [.github](.github/README.md)
* [CONTRIBUTING](.github/contributing.md)

3 changes: 3 additions & 0 deletions ISSUE_TEMPLATE.md → issue_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# ISSUE\_TEMPLATE

DBFlow Version:

Bug or Feature Request:

Description:

163 changes: 0 additions & 163 deletions usage2/ListBasedQueries.md

This file was deleted.

3 changes: 2 additions & 1 deletion usage2/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DBFlow
# README

DBFlow is a Kotlin SQLite library for Android that makes it ridiculously easy to interact and use databases. Built with Annotation Processing, code use within a DB is fast, efficient, and type-safe. It removes the tedious \(and tough-to-maintain\) database interaction code, while providing a very SQLite-like query syntax.

Expand Down Expand Up @@ -85,3 +85,4 @@ async {
}
}
```

29 changes: 0 additions & 29 deletions usage2/SUMMARY.md

This file was deleted.

2 changes: 0 additions & 2 deletions usage2/advanced-usage.md → usage2/advanced-usage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,3 @@

This section details the more advanced usages of DBFlow.



Loading

0 comments on commit cfc5d46

Please sign in to comment.