Add basic README with notes on what's included (or what to include in the future).

Ryan Glover
1 parent 6081097227
Showing 1 changed file with 25 additions and 0 deletions Show diff stats
README.md
@@ -0,0 +1,25 @@
+# The Meteor Chef - Base
+A starting point for Meteor apps.
+
+Base is the lazy person's starter kit for Meteor. It includes some commonly used packages (biased to The Meteor Chef) and code for common functionality.
+
+### Packages Included
+Accounts (Base) - `meteor add accounts-base`
+Accounts (Password) - `meteor add accounts-password`
+Audit Argument Checks - `meteor add audit-argument-checks`
+Bootstrap 3 - `mrt add bootstrap-3`
+Check - `meteor add check`
+CoffeeScript - `meteor add coffeescript`
+Handlebars Server - `mrt add handlebars-server`
+Iron Router - `mrt add iron-router`
+jQuery - `meteor add jquery`
+Sass - `mrt add sass`
+Underscore - `meteor add underscore`
+
+### Functionality
+
+###### Basic Routing (Not Included Yet, Just Documenting)
+A collection of pre-defined routes and templates for common functionality (see Authenticate below). Also includes a set of common route filters for managing user access.
+
+###### Authentication (Not Included Yet, Just Documenting)
+A complete authentication pattern complete with: signup, login, and password recovery. Also includes an automated user creation script in `/server/startup.coffee`.
...	...	@@ -0,0 +1,25 @@
	1	+# The Meteor Chef - Base
	2	+A starting point for Meteor apps.
	3	+
	4	+Base is the lazy person's starter kit for Meteor. It includes some commonly used packages (biased to The Meteor Chef) and code for common functionality.
	5	+
	6	+### Packages Included
	7	+Accounts (Base) - `meteor add accounts-base`
	8	+Accounts (Password) - `meteor add accounts-password`
	9	+Audit Argument Checks - `meteor add audit-argument-checks`
	10	+Bootstrap 3 - `mrt add bootstrap-3`
	11	+Check - `meteor add check`
	12	+CoffeeScript - `meteor add coffeescript`
	13	+Handlebars Server - `mrt add handlebars-server`
	14	+Iron Router - `mrt add iron-router`
	15	+jQuery - `meteor add jquery`
	16	+Sass - `mrt add sass`
	17	+Underscore - `meteor add underscore`
	18	+
	19	+### Functionality
	20	+
	21	+###### Basic Routing (Not Included Yet, Just Documenting)
	22	+A collection of pre-defined routes and templates for common functionality (see Authenticate below). Also includes a set of common route filters for managing user access.
	23	+
	24	+###### Authentication (Not Included Yet, Just Documenting)
	25	+A complete authentication pattern complete with: signup, login, and password recovery. Also includes an automated user creation script in `/server/startup.coffee`.
...	...