bring README.md files up to 1.0.3 compatibility

Fill in all packages without README.md files with a short README.md mentioning that this is an internal Meteor package. Break up the top paragraph of a couple of existing README.md files to be proper long description. There is more work to do here, involving line wrapping and the like.
jgdovin · Jan 20, 2015 · c5bc843 · c5bc843
1 parent 1aba3a8
commit c5bc843
Show file tree

Hide file tree

Showing 55 changed files with 83 additions and 11 deletions.
diff --git a/packages/accounts-ui/README.md b/packages/accounts-ui/README.md
@@ -2,13 +2,19 @@
 
 A turn-key user interface for Meteor Accounts.
 
-To add Accounts and a set of login controls to an application, add the
-`accounts-ui` package and at least one login provider package:
+To add Accounts and a set of login controls to an application, add the `accounts-ui`
+package and at least one login provider package:
 `accounts-password`, `accounts-facebook`, `accounts-github`,
 `accounts-google`, `accounts-twitter`, or `accounts-weibo`.
 
-Then simply add the `{{> loginButtons}}` helper to an HTML file. This
-will place a login widget on the page. If there is only one provider configured
+Then simply add the `{{> loginButtons}}` helper to an HTML file.
+
+See the Meteor Accounts [project page](https://www.meteor.com/accounts) for more info.
+
+## Details
+
+Adding the `{{> loginButtons}}` helper to an HTML file will
+place a login widget on the page. If there is only one provider configured
 and it is an external service, this will add a login/logout button. If you use
 `accounts-password` or use multiple external login services, this will add
 a "Sign in" link which opens a dropdown menu with login options. If you plan to

diff --git a/packages/appcache/README.md b/packages/appcache/README.md
@@ -4,7 +4,11 @@ The `appcache` package, part of
 [Webapp](https://www.meteor.com/webapp), stores the static parts of a
 Meteor application (the client side Javascript, HTML, CSS, and images)
 in the browser's [application
-cache](https://en.wikipedia.org/wiki/AppCache). To enable caching
+cache](https://en.wikipedia.org/wiki/AppCache).
+
+## Using Appcache
+
+To enable caching
 simply add the `appcache` package to your project.
 
 * Once a user has visited a Meteor application for the first time and

diff --git a/packages/application-configuration/README.md b/packages/application-configuration/README.md
@@ -0,0 +1,3 @@
+# Application-Configuration
+
+This is an internal Meteor package.
diff --git a/packages/audit-argument-checks/README.md b/packages/audit-argument-checks/README.md
@@ -0,0 +1,3 @@
+# Audit-Argument-Checks
+
+This is an internal Meteor package.
diff --git a/packages/base64/README.md b/packages/base64/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/binary-heap/README.md b/packages/binary-heap/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/blaze/README.md b/packages/blaze/README.md
@@ -11,6 +11,10 @@ manipulates the DOM.  Instead, familiar template directives like
 [Minimongo's](https://meteor.com/mini-databases) database cursors so
 that the DOM updates automatically.
 
+Read more on the Blaze [project page](http://www.meteor.com/blaze).
+
+## Details
+
 Blaze has two major parts:
 
 * A template compiler that compiles template files into JavaScript
@@ -32,8 +36,6 @@ experience, using templating, transparent reactivity, and
 interoperability with existing libraries to create a gentle learning
 curve while enabling you to build world-class apps.
 
-Read more on the Blaze [project page](http://www.meteor.com/blaze).
-
 ## Examples
 
 Here are two Spacebars templates from an example app called

diff --git a/packages/boilerplate-generator/README.md b/packages/boilerplate-generator/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/browser-policy/README.md b/packages/browser-policy/README.md
@@ -6,6 +6,8 @@ policies that will be enforced by newer browsers. These policies help
 you prevent and mitigate common attacks like cross-site scripting and
 clickjacking.
 
+## Details
+
 When you add `browser-policy` to your app, you get default configurations for
 the HTTP headers X-Frame-Options and Content-Security-Policy. X-Frame-Options
 tells the browser which websites are allowed to frame your app. You should only

diff --git a/packages/callback-hook/README.md b/packages/callback-hook/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/code-prettify/README.md b/packages/code-prettify/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/coffeescript-test-helper/README.md b/packages/coffeescript-test-helper/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/ctl-helper/README.md b/packages/ctl-helper/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/ctl/README.md b/packages/ctl/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/deps/README.md b/packages/deps/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/dev-bundle-fetcher/README.md b/packages/dev-bundle-fetcher/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/disable-oplog/README.md b/packages/disable-oplog/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/facts/README.md b/packages/facts/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/follower-livedata/README.md b/packages/follower-livedata/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/geojson-utils/README.md b/packages/geojson-utils/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/handlebars/README.md b/packages/handlebars/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/id-map/README.md b/packages/id-map/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/js-analyze-tests/README.md b/packages/js-analyze-tests/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/js-analyze/README.md b/packages/js-analyze/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/jsparse/README.md b/packages/jsparse/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/livedata/README.md b/packages/livedata/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/localstorage/README.md b/packages/localstorage/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/logging/README.md b/packages/logging/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/markdown/README.md b/packages/markdown/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/meteor-tool/.versions b/packages/meteor-tool/.versions
@@ -0,0 +1,3 @@
+[email protected]
+[email protected]
+[email protected]
diff --git a/packages/meteor/README.md b/packages/meteor/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/meyerweb-reset/README.md b/packages/meyerweb-reset/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/minifiers/README.md b/packages/minifiers/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/mongo-livedata/README.md b/packages/mongo-livedata/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/observe-sequence/README.md b/packages/observe-sequence/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/package-version-parser/README.md b/packages/package-version-parser/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/preserve-inputs/README.md b/packages/preserve-inputs/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/reload-safetybelt/README.md b/packages/reload-safetybelt/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/retry/README.md b/packages/retry/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/sha/README.md b/packages/sha/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/showdown/README.md b/packages/showdown/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/spacebars-tests/README.md b/packages/spacebars-tests/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/spiderable/README.md b/packages/spiderable/README.md
@@ -19,12 +19,14 @@ pushState](https://developer.mozilla.org/en-US/docs/DOM/Manipulating_the_browser
 to alter the URL on the client without triggering a page reload. See the [Todos
 example](http://meteor.com/examples/todos) for a demonstration.
 
-If you deploy your application with `meteor bundle`, you must install
-`phantomjs` ([http://phantomjs.org](http://phantomjs.org/)) somewhere in your
-`$PATH`. If you use `meteor deploy` this is already taken care of.
-
 When running your page, `spiderable` will wait for all publications
 to be ready. Make sure that all of your [`publish functions`](#meteor_publish)
 either return a cursor (or an array of cursors), or eventually call
 [`this.ready()`](#publish_ready). Otherwise, the `phantomjs` executions
 will fail.
+
+## Notes
+
+If you deploy your application with `meteor bundle`, you must install
+`phantomjs` ([http://phantomjs.org](http://phantomjs.org/)) somewhere in your
+`$PATH`. If you use `meteor deploy` this is already taken care of.
diff --git a/packages/srp/README.md b/packages/srp/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/standard-app-packages/README.md b/packages/standard-app-packages/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/star-translate/README.md b/packages/star-translate/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/startup/README.md b/packages/startup/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/test-helpers/README.md b/packages/test-helpers/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/test-in-console/README.md b/packages/test-in-console/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/test-server-tests-in-console-once/README.md b/packages/test-server-tests-in-console-once/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/tinytest/README.md b/packages/tinytest/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/ui/README.md b/packages/ui/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/underscore-tests/README.md b/packages/underscore-tests/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/url/README.md b/packages/url/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
diff --git a/packages/xmlbuilder/README.md b/packages/xmlbuilder/README.md
@@ -0,0 +1 @@
+This is an internal Meteor package.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Application-Configuration

		This is an internal Meteor package.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Audit-Argument-Checks

		This is an internal Meteor package.