Documentation updates

CHANGELOG.md

@@ -3,6 +3,72 @@ Collection2
 
 A smart package for Meteor that extends Mongo.Collection to provide support for specifying a schema and then validating against that schema when inserting and updating.
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Collection2](#collection2)
+  - [Change Log](#change-log)
+    - [2.9.1](#291)
+    - [2.9.0](#290)
+    - [2.8.0](#280)
+    - [2.7.1](#271)
+    - [2.7.0](#270)
+    - [2.6.1](#261)
+    - [2.6.0](#260)
+    - [2.5.0](#250)
+    - [2.4.0](#240)
+    - [2.3.3](#233)
+    - [2.3.2](#232)
+    - [2.3.1](#231)
+    - [2.3.0](#230)
+    - [2.2.0](#220)
+    - [2.1.0](#210)
+    - [2.0.1](#201)
+    - [2.0.0](#200)
+    - [1.0.0](#100)
+    - [0.4.6](#046)
+    - [0.4.5](#045)
+    - [0.4.4](#044)
+    - [0.4.3](#043)
+    - [0.4.2](#042)
+    - [0.4.1](#041)
+    - [0.4.0](#040)
+    - [0.3.11](#0311)
+    - [0.3.10](#0310)
+    - [0.3.9](#039)
+    - [0.3.8](#038)
+    - [0.3.7](#037)
+    - [0.3.6](#036)
+    - [0.3.5](#035)
+    - [0.3.4](#034)
+    - [0.3.3](#033)
+    - [0.3.2](#032)
+    - [0.3.1](#031)
+    - [0.3.0](#030)
+    - [0.2.17](#0217)
+    - [0.2.16](#0216)
+    - [0.2.15](#0215)
+    - [0.2.14](#0214)
+    - [0.2.13](#0213)
+    - [0.2.12](#0212)
+    - [0.2.11](#0211)
+    - [0.2.10](#0210)
+    - [0.2.9](#029)
+    - [0.2.8](#028)
+    - [0.2.7](#027)
+    - [0.2.6](#026)
+    - [0.2.5](#025)
+    - [0.2.4](#024)
+    - [0.2.3](#023)
+    - [0.2.2](#022)
+    - [0.2.1](#021)
+    - [0.2.0](#020)
+    - [0.1.7](#017)
+    - [0.1.6](#016)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Change Log
 
 ### 2.9.1

README.md

@@ -7,6 +7,64 @@ A Meteor package that allows you to attach a schema to a Mongo.Collection. Autom
 
 This package requires and automatically installs the [aldeed:simple-schema](https://github.com/aldeed/meteor-simple-schema) package, which defines the schema syntax and provides the validation logic.
 
+## IMPORTANT NOTE! THE VERSION IN THIS REPO IS DEPRECATED
+
+`aldeed:collection2` package is no longer supported. Please update to [aldeed:collection2-core@2.x.x](https://github.com/aldeed/meteor-collection2-core), which has an implicit dependency on the SimpleSchema NPM package rather than an explicit dependency on the SimpleSchema Meteor package. When doing this, be aware of the breaking changes in [SimpleSchema 2.0](https://github.com/aldeed/meteor-simple-schema/blob/v2/CHANGELOG.md#200).
+
+This is how to update an app from Collection2 1.x.x to 2.x.x, not including any schema changes you need to make due to the SimpleSchema update:
+
+```
+meteor remove aldeed:simple-schema aldeed:collection2
+meteor add aldeed:collection2-core@2.0.0
+meteor npm install --save simpl-schema
+```
+
+Then add `import SimpleSchema from 'simpl-schema';` at the top of all files in your app that reference the `SimpleSchema` object. (It is no longer an automatic global.)
+
+- `aldeed:collection2-core` does not include `denyInsert` or `denyUpdate` options. If any of your schemas use those options, `meteor add aldeed:schema-deny`
+- `aldeed:collection2-core` does not include `index` or `unique` options. If any of your schemas use those options, `meteor add aldeed:schema-index`
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Collection2](#collection2)
+  - [IMPORTANT NOTE! THE VERSION IN THIS REPO IS DEPRECATED](#important-note-the-version-in-this-repo-is-deprecated)
+  - [Installation](#installation)
+  - [Why Use Collection2?](#why-use-collection2)
+  - [Attaching a Schema to a Collection](#attaching-a-schema-to-a-collection)
+    - [Attaching Multiple Schemas to the Same Collection](#attaching-multiple-schemas-to-the-same-collection)
+    - [attachSchema options](#attachschema-options)
+      - [transform](#transform)
+      - [replace](#replace)
+    - [Attach a Schema to Meteor.users](#attach-a-schema-to-meteorusers)
+  - [Schema Format](#schema-format)
+  - [Passing Options](#passing-options)
+  - [Validation Contexts](#validation-contexts)
+  - [Validating Without Inserting or Updating](#validating-without-inserting-or-updating)
+  - [Inserting or Updating Without Validating](#inserting-or-updating-without-validating)
+  - [Inserting or Updating Without Cleaning](#inserting-or-updating-without-cleaning)
+    - [Skip removing properties that are not in the schema](#skip-removing-properties-that-are-not-in-the-schema)
+    - [Skip conversion of values to match what schema expects](#skip-conversion-of-values-to-match-what-schema-expects)
+    - [Skip removing empty strings](#skip-removing-empty-strings)
+    - [Skip generating automatic values](#skip-generating-automatic-values)
+  - [Inserting or Updating Bypassing Collection2 Entirely](#inserting-or-updating-bypassing-collection2-entirely)
+  - [Additional SimpleSchema Options](#additional-simpleschema-options)
+    - [index and unique](#index-and-unique)
+    - [denyInsert and denyUpdate](#denyinsert-and-denyupdate)
+    - [autoValue](#autovalue)
+    - [custom](#custom)
+  - [What Happens When The Document Is Invalid?](#what-happens-when-the-document-is-invalid)
+  - [More Details](#more-details)
+  - [Community Add-On Packages](#community-add-on-packages)
+    - [Automatic Migrations](#automatic-migrations)
+  - [Problems?](#problems)
+    - [SubObjects and Arrays of Objects](#subobjects-and-arrays-of-objects)
+  - [Contributing](#contributing)
+    - [Major Contributors](#major-contributors)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Installation
 
 In your Meteor app directory, enter: