docs: cleanup readme and older versions usage

Author: theoludwig

CHANGELOG.md

@@ -13,3 +13,67 @@ Initial release with Changelog.
 ### Features
 
 - infer bigint data type ([#893](https://github.com/RobinBuschmann/sequelize-typescript/issues/893)) ([7c467d4](https://github.com/RobinBuschmann/sequelize-typescript/commit/7c467d404a200b3153cc7aa2605d1e542bef3da9))
+
+## Older versions
+
+### ⚠️ sequelize@5
+
+`sequelize@5` requires `sequelize-typescript@1`. See
+[documentation](https://github.com/RobinBuschmann/sequelize-typescript/tree/1.0.0) for version `1.0`.
+
+```sh
+npm install [email protected]
+```
+
+#### V5 Model definition
+
+```typescript
+import { Table, Model } from 'sequelize-typescript'
+
+@Table
+class Person extends Model<Person> {}
+```
+
+### ⚠️ sequelize@4
+
+`sequelize@4` requires `[email protected]`. See
+[documentation](https://github.com/RobinBuschmann/sequelize-typescript/tree/0.6.X) for version `0.6`.
+
+```sh
+npm install [email protected]
+```
+
+### Upgrade to `sequelize-typescript@2`
+
+- `sequelize-typescript@2` only works with `[email protected]>=`.
+  For `sequelize@5` use `[email protected]`.
+
+#### Breaking Changes
+
+- All breaking changes of `sequelize@6` are also valid for `sequelize-typescript@2`.
+  See [Upgrade to v6](https://sequelize.org/master/manual/upgrade-to-v6.html) for details.
+- `@types/bluebird` is no longer needed, `sequelize@6` removed usage of `bluebird`
+- Sequelize v6.2 introduced additional model attributes typings, which affects how the model is defined.
+- See below comparison between V5 and V6 model definition to show how to upgrade models.
+- For more details, see [sequelize typescript docs](https://sequelize.org/master/manual/typescript.html).
+
+### Upgrade to `sequelize-typescript@1`
+
+`sequelize-typescript@1` only works with `sequelize@5>=`.
+For `sequelize@4` & `sequelize@3` use `[email protected]`.
+
+#### Breaking Changes @5
+
+All breaking changes of `sequelize@5` are also valid for `sequelize-typescript@1`.
+See [Upgrade to v5](https://sequelize.org/v5/manual/upgrade-to-v5.html) for details.
+
+#### Official Sequelize Typings
+
+sequelize-typescript now uses the official typings bundled with sequelize
+(See [this](https://sequelize.org/v5/manual/upgrade-to-v5.html#typescript-support)).
+Please note the following details:
+
+- Most of the sequelize-typescript interfaces of the previous version are replaced by the official ones
+- `@types/sequelize` is no longer used
+- `@types/bluebird` is no longer an explicit dependency
+- The official typings are less strict than the former sequelize-typescript ones

README.md

@@ -8,8 +8,6 @@
 Decorators and some other features for sequelize (v6).
 
 - [Installation](#installation)
-- [Upgrade to `sequelize-typescript@2`](#upgrade-to-sequelize-typescript2)
-- [Upgrade to `sequelize-typescript@1`](#upgrade-to-sequelize-typescript1)
 - [Model Definition](#model-definition)
   - [`@Table` API](#table-api)
   - [`@Column` API](#column-api)
@@ -27,7 +25,7 @@ Decorators and some other features for sequelize (v6).
 - [Indexes](#indexes)
   - [`@Index` API](#index)
   - [`createIndexDecorator()` API](#createindexdecorator)
-- [Repository mode](#repository-mode-1)
+- [Repository mode](#repository-mode)
   - [How to enable repository mode?](#how-to-enable-repository-mode)
   - [How to use repository mode?](#how-to-use-repository-mode)
   - [How to use associations with repository mode?](#how-to-use-associations-with-repository-mode)
@@ -45,13 +43,8 @@ Decorators and some other features for sequelize (v6).
 - additional typings as documented [here](https://sequelize.org/master/manual/typescript.html) and [reflect-metadata](https://www.npmjs.com/package/reflect-metadata)
 
 ```sh
-npm install sequelize
-npm install @types/node @types/validator
-npm install reflect-metadata
-```
-
-```sh
-npm install sequelize-typescript
+npm install --save-dev @types/node @types/validator
+npm install sequelize reflect-metadata sequelize-typescript
 ```
 
 Your `tsconfig.json` needs the following flags:
@@ -62,48 +55,46 @@ Your `tsconfig.json` needs the following flags:
 "emitDecoratorMetadata": true
 ```
 
-### ⚠️ sequelize@5
+### Sequelize Options
 
-`sequelize@5` requires `sequelize-typescript@1`. See
-[documentation](https://github.com/RobinBuschmann/sequelize-typescript/tree/1.0.0) for version `1.0`.
-
-```sh
-npm install [email protected]
-```
+- `SequelizeConfig` renamed to `SequelizeOptions`
+- `modelPaths` property renamed to `models`
 
-### ⚠️ sequelize@4
+### Scopes Options
 
-`sequelize@4` requires `[email protected]`. See
-[documentation](https://github.com/RobinBuschmann/sequelize-typescript/tree/0.6.X) for version `0.6`.
+The `@Scopes` and `@DefaultScope` decorators now take lambda's as options
 
-```sh
-npm install [email protected]
+```ts
+@DefaultScope(() => ({...}))
+@Scopes(() => ({...}))
 ```
 
-## Upgrade to `sequelize-typescript@2`
-
-- `sequelize-typescript@2` only works with `[email protected]>=`.
-  For `sequelize@5` use `[email protected]`.
-
-### Breaking Changes
+instead of deprecated way:
 
-- All breaking changes of `sequelize@6` are also valid for `sequelize-typescript@2`.
-  See [Upgrade to v6](https://sequelize.org/master/manual/upgrade-to-v6.html) for details.
-- `@types/bluebird` is no longer needed, `sequelize@6` removed usage of `bluebird`
-- Sequelize v6.2 introduced additional model attributes typings, which affects how the model is defined.
-- See below comparison between V5 and V6 model definition to show how to upgrade models.
-- For more details, see [sequelize typescript docs](https://sequelize.org/master/manual/typescript.html).
+```ts
+@DefaultScope({...})
+@Scopes({...}))
+```
 
-#### V5 Model definition
+## Model definition
 
 ```typescript
-import { Table, Model } from 'sequelize-typescript'
+import { Table, Column, Model, HasMany } from 'sequelize-typescript'
 
 @Table
-class Person extends Model<Person> {}
+class Person extends Model {
+  @Column
+  name: string
+
+  @Column
+  birthday: Date
+
+  @HasMany(() => Hobby)
+  hobbies: Hobby[]
+}
 ```
 
-#### V6 Model definition (less strict)
+### Less strict
 
 ```typescript
 import { Table, Model } from 'sequelize-typescript'
@@ -112,10 +103,7 @@ import { Table, Model } from 'sequelize-typescript'
 class Person extends Model {}
 ```
 
-#### V6 Model definition (more strict)
-
-- ⚠️ not yet implemented in `sequelize-typescript`
-- to allow more strict model attributes type-checks, you can define `ModelAttributes` and `ModelCreationAttributes` interfaces
+### More strict
 
 ```typescript
 import { Optional } from 'sequelize'
@@ -132,70 +120,6 @@ interface PersonCreationAttributes extends Optional<PersonAttributes, 'id'> {}
 class Person extends Model<PersonAttributes, PersonCreationAttributes> {}
 ```
 
-## Upgrade to `sequelize-typescript@1`
-
-`sequelize-typescript@1` only works with `sequelize@5>=`.
-For `sequelize@4` & `sequelize@3` use `[email protected]`.
-
-### Breaking Changes @5
-
-All breaking changes of `sequelize@5` are also valid for `sequelize-typescript@1`.
-See [Upgrade to v5](https://sequelize.org/v5/manual/upgrade-to-v5.html) for details.
-
-#### Official Sequelize Typings
-
-sequelize-typescript now uses the official typings bundled with sequelize
-(See [this](https://sequelize.org/v5/manual/upgrade-to-v5.html#typescript-support)).
-Please note the following details:
-
-- Most of the sequelize-typescript interfaces of the previous version are replaced by the official ones
-- `@types/sequelize` is no longer used
-- `@types/bluebird` is no longer an explicit dependency
-- The official typings are less strict than the former sequelize-typescript ones
-
-#### Sequelize Options
-
-- `SequelizeConfig` renamed to `SequelizeOptions`
-- `modelPaths` property renamed to `models`
-
-#### Scopes Options
-
-The `@Scopes` and `@DefaultScope` decorators now take lambda's as options
-
-```ts
-@DefaultScope(() => ({...}))
-@Scopes(() => ({...}))
-```
-
-instead of deprecated way:
-
-```ts
-@DefaultScope({...})
-@Scopes({...}))
-```
-
-### Repository Mode
-
-With `sequelize-typescript@1` comes a repository mode. See [docs](#repository-mode-1) for details.
-
-## Model definition
-
-```typescript
-import { Table, Column, Model, HasMany } from 'sequelize-typescript'
-
-@Table
-class Person extends Model {
-  @Column
-  name: string
-
-  @Column
-  birthday: Date
-
-  @HasMany(() => Hobby)
-  hobbies: Hobby[]
-}
-```
-
 The model needs to extend the `Model` class and has to be annotated with the `@Table` decorator. All properties that
 should appear as a column in the database require the `@Column` annotation.
 
@@ -791,6 +715,8 @@ class Person extends Model {
 
 ## Repository mode
 
+With `sequelize-typescript@1` comes a repository mode. See [docs](#repository-mode-1) for details.
+
 The repository mode makes it possible to separate static operations like `find`, `create`, ... from model definitions.
 It also empowers models so that they can be used with multiple sequelize instances.