added docs for future edit

docs/connection-and-options.md

@@ -0,0 +1,25 @@
+# Connection and connection options
+
+* What is `Connection` in TypeORM
+* Creating a new connection
+    * Creating a new connection using main api
+    * Creating connection using `ConnectionManager`
+* Creating a new connection from the configuration files
+    * Loading from `ormconfig.json`
+    * Loading from `ormconfig.env`
+    * Loading from `ormconfig.yml`
+    * Loading from `ormconfig.xml`
+* Connection options
+    * Common connection options
+    * Specific options for `mysql` / `mariadb`
+    * Specific options for `postgres`
+    * Specific options for `sqlite` / `websql`
+    * Specific options for `mssql`
+    * Specific options for `mongodb`
+* Working with connection
+* Connection usage example in sample express application
+* Using service container and typedi extensions
+* API
+    * Main API
+    * `Connection` class API
+    * `ConnectionManager` class API

docs/decorator-reference.md

@@ -0,0 +1,7 @@
+# Decorators reference
+
+* Entity decorators
+* Column decorators
+* Relation decorators
+* Subscriber and listener decorators
+* Other decorators

docs/entity-manager-and-repository.md

@@ -0,0 +1,9 @@
+# Entity Manager and Repository
+
+* What is EntityManager
+* What is Repository
+* Using `FindOptions`
+* Tree Repository
+* MongoDB Repository
+* Custom Repository
+* API

docs/extra-features.md

@@ -0,0 +1,4 @@
+# Extra features
+
+* Using custom logger
+* Using in browsers

docs/indices.md

@@ -0,0 +1,5 @@
+# Indices
+
+* Column indices
+* Unique indices
+* Indices with multiple columns

docs/migrations.md

@@ -0,0 +1,6 @@
+# Migrations
+
+* Creating a new empty migration
+* Running and reverting migrations
+* Generating migrations
+* Using migration API to write migrations [TBD]

docs/mongodb.md

@@ -0,0 +1,8 @@
+# MongoDB
+
+* MongoDB support
+* Defining entities and columns
+* Defining subdocuments (embed documents)
+* Using `MongoEntityManager`
+* Using `MongoRepository`
+* Defining indices

docs/naming-strategy.md

@@ -0,0 +1,7 @@
+# Naming strategy [TBD]
+
+* Specify custom table name
+* Specify custom column name
+* Specify custom foreign column name
+* Specify custom many-to-many junction table name
+* Creating your own `NamingStrategy`

docs/query-builder.md

@@ -0,0 +1,29 @@
+# Query Builder
+
+* What is `QueryBuilder`
+* How to create and use a `QueryBuilder`
+* Building `SELECT` queries
+    * Getting values using `QueryBuilder`
+    * Adding `WHERE` expression
+    * Adding `HAVING` expression
+    * Adding `ORDER BY` expression
+    * Adding `GROUP BY` expression
+    * Adding `LIMIT` expression
+    * Adding `OFFSET` expression
+    * Using parameters to escape data
+    * Joining relations
+    * Joining any entity or table
+    * Joining and mapping functionality
+    * Getting result query
+    * Getting raw result
+    * Streaming result data
+    * Using pagination
+    * Set locking
+    * Partial selection
+    * Using subqueries
+* Building `INSERT` query
+* Building `UPDATE` query
+* Building `DELETE` query
+* Using `RelationQueryBuilder`
+* Usage examples
+* API

docs/relations.md

@@ -0,0 +1,11 @@
+# Relations
+
+* What are relations
+* One-to-one relation
+* Many-to-one / One-to-many relations
+* Many-to-many relation
+* How to load relations in entities
+* Relation options
+* Lazy relations
+* Eager relations
+* Usage examples

docs/schema-in-files.md

@@ -0,0 +1,2 @@
+# Defining entity schemas in json files [TBD]
+  

docs/subscribers-and-listeners.md

@@ -0,0 +1,5 @@
+# Subscribers and Entity Listeners
+
+* What is Subscriber
+* What is Entity Listener
+* API

docs/table-and-columns.md

@@ -0,0 +1,13 @@
+# Table and columns
+
+* What is Entity
+* Entity columns
+* Column types
+    * Column types for `mysql` / `mariadb`
+    * Column types for `postgres`
+    * Column types for `sqlite` / `websql`
+    * Column types for `mssql`
+    * Column types for `mongodb`
+* Entity inheritance
+* Embedded entities
+* Tree entities

docs/transactions.md

@@ -0,0 +1,5 @@
+# Transactions
+
+* Creating and using transactions
+* Transaction decorators
+* Using `QueryRunner` to create and control state of single database connection

docs/usage-with-javascript.md

@@ -0,0 +1,2 @@
+# Using with JavaScript
+  

docs/using-cli.md

@@ -0,0 +1,13 @@
+# Using CLI
+
+* Create a new entity
+* Create a new subscriber
+* Create a new migration file
+* Create migration from exist table schema
+* Run migrations
+* Revert migrations
+* Sync database schema
+* Log sync database schema queries without actual running them
+* Completely drop database schema
+* Run any sql query
+* Create database backup [TBD]