Skip to content

Commit dda0c44

Browse files
author
Sashko Stubailo
committedOct 23, 2014
Add a bunch of READMEs
1 parent b219b8f commit dda0c44

File tree

31 files changed

+163
-0
lines changed

31 files changed

+163
-0
lines changed
 

‎packages/accounts-base/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# accounts-base
2+
3+
Meteor's user account system. This package implements the basic functions necessary for user accounts and lets other packages register login services. Some of these services are in the following packages:
4+
5+
- `accounts-password`
6+
- `accounts-facebook`
7+
- `accounts-google`
8+
- `accounts-github`
9+
- `accounts-twitter`
10+
- `accounts-meetup`
11+
- `accounts-weibo`
12+
13+
There are also login services available in community packages.
14+
15+
For more information, see the [Meteor docs](http://docs.meteor.com/#accounts_api) and the Meteor Accounts project page. XXX link

‎packages/accounts-facebook/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-facebook
2+
3+
A login service for Facebook. See the project page on Meteor Accounts for more details. XXX link

‎packages/accounts-github/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-github
2+
3+
A login service for GitHub. See the project page on Meteor Accounts for more details. XXX link

‎packages/accounts-google/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-google
2+
3+
A login service for Google. See the project page on Meteor Accounts for more details. XXX link

‎packages/accounts-meetup/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-meetup
2+
3+
A login service for Meetup. See the project page on Meteor Accounts for more details. XXX link
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-meteor-developer
2+
3+
A login service for Meteor developer accounts. See the project page on Meteor Accounts and Meteor Developer Accounts for more details. XXX 2 links

‎packages/accounts-oauth/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-oauth
2+
3+
Common functionality for OAuth-based login services. See the project page on Meteor Accounts for more details. XXX link

‎packages/accounts-password/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-password
2+
3+
A login service that enables secure password-based login. See the project page on Meteor Accounts for more details. XXX link

‎packages/accounts-twitter/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-twitter
2+
3+
A login service for Twitter. See the project page on Meteor Accounts for more details. XXX link
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-ui-unstyled
2+
3+
A version of `accounts-ui` without the CSS, so that you can add your own styling. See the `accounts-ui` README and the Meteor Accounts project page for details. XXX link

‎packages/accounts-weibo/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# accounts-weibo
2+
3+
A login service for Weibo. See the project page on Meteor Accounts for more details. XXX link

‎packages/autopublish/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# autopublish
2+
3+
Publish all server collections to the client. This package is useful for prototyping an app without worrying about which clients have access to certain data, but should be removed as soon as the app needs to restrict which data is seen by the client.
4+
5+
The `autopublish` package is automatically added to every Meteor app by `meteor create`.

‎packages/ddp/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ddp
2+
3+
DDP is the stateful websocket protocol that Meteor uses to communicate between the client and the server. This package is used internally by almost every Meteor app.
4+
5+
You can use it directly by calling [`DDP.connect`](http://docs.meteor.com/#ddp_connect) to connect to any DDP server.
6+
7+
See the project page on DDP for more details. XXX link

‎packages/facebook/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# facebook
2+
3+
An implementation of the Facebook OAuth flow. See the project page on Meteor Accounts for more details. XXX link

‎packages/github/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# github
2+
3+
An implementation of the GitHub OAuth flow. See the project page on Meteor Accounts for more details. XXX link

‎packages/google/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# google
2+
3+
An implementation of the Google OAuth flow. See the project page on Meteor Accounts for more details. XXX link

‎packages/insecure/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# insecure
2+
3+
Allow almost all collection methods, such as `insert`, `update`, and `remove`, to be called from the client. This package is useful for prototyping an app without worrying about database permissions, but should be removed as soon as the app needs to restrict database access.
4+
5+
The `insecure` package is automatically added to every Meteor app by `meteor create`.

‎packages/meetup/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# meetup
2+
3+
An implementation of the Meetup OAuth flow. See the project page on Meteor Accounts for more details. XXX link

‎packages/meteor-developer/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# meteor-developer
2+
3+
An implementation of the Meteor Developer Account OAuth flow. See the project page on Meteor Accounts for more details. XXX link

‎packages/meteor-platform/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# meteor-platform
2+
3+
This package is added to every app by `meteor create`. It includes a set of common packages that most Meteor apps will find useful:
4+
5+
- `meteor`
6+
- `webapp`
7+
- `logging`
8+
- `tracker`
9+
- `session`
10+
- `ddp`
11+
- `mongo`
12+
- `blaze`
13+
- `spacebars`
14+
- `templating`
15+
- `check`
16+
- `underscore`
17+
- `jquery`
18+
- `random`
19+
- `ejson`
20+
21+
See the README of each individual package to learn more about it.

‎packages/meteor-tool/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# meteor-tool
2+
3+
This is the Meteor command-line tool. Most of the code for it is in the [tools directory](https://github.com/meteor/meteor/tree/master/tools) of the Meteor repository.
4+
5+
The Meteor tool also includes testing functionality and example apps for the Meteor framework.
6+
7+
Read more about it on the project page: XXX link

‎packages/oauth/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# oauth
2+
3+
Common functionality for OAuth clients. See the project page on Meteor Accounts for more details. XXX link

‎packages/oauth1/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# oauth1
2+
3+
Common functionality for OAuth 1 clients. See the project page on Meteor Accounts for more details. XXX link

‎packages/oauth2/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# oauth2
2+
3+
Common functionality for OAuth 2 clients. See the project page on Meteor Accounts for more details. XXX link
+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# package-stats-opt-out
2+
3+
Opt out of sending statistics about which packages your app is using.
4+
5+
Read more about the Meteor packaging system on the Isopack project page. XXX link
+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# service-configuration
2+
3+
Configure login services. Example:
4+
5+
```
6+
// first, remove configuration entry in case service is already configured
7+
ServiceConfiguration.configurations.remove({
8+
service: "weibo"
9+
});
10+
ServiceConfiguration.configurations.insert({
11+
service: "weibo",
12+
clientId: "1292962797",
13+
secret: "75a730b58f5691de5522789070c319bc"
14+
});
15+
```
16+
17+
Read more in the [Meteor docs](http://docs.meteor.com/#meteor_loginwithexternalservice) and the Meteor Accounts project page. XXX link

‎packages/spacebars-compiler/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# spacebars-compiler
2+
3+
The compiler for the spacebars template language. Used by several Meteor packages to compile HTML into Blaze templates.
4+
5+
Read more about Spacebars, Blaze, and Meteor templating on the Blaze project page. XXX link

‎packages/stylus/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# stylus
2+
3+
Compile `.styl` files in your Meteor app into CSS stylesheets. Stylus is "Expressive, dynamic, robust CSS".
4+
5+
See the [Stylus website](http://learnboost.github.io/stylus/) for more details.

‎packages/templating/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# templating
2+
3+
Define Blaze templates in `.html` files. Most Meteor apps use this package.
4+
5+
This build plugin parses all of the HTML files in your app and looks for three top-level tags:
6+
7+
- `<head>` - appended to the `head` section of your HTML
8+
- `<body>` - appended to the `body` section of your HTML
9+
- `<template name="templateName">` - compiled into a Blaze template, which can be included with `{{> templateName}} or referenced in JS code with `Template.templateName`.
10+
11+
For more details, see the [Meteor docs about templating](http://docs.meteor.com/#livehtmltemplates) and the Blaze project page. XXX link

‎packages/twitter/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# twitter
2+
3+
An implementation of the Twitter OAuth flow. See the project page on Meteor Accounts for more details. XXX link

‎packages/weibo/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# weibo
2+
3+
An implementation of the Weibo OAuth flow. See the project page on Meteor Accounts for more details. XXX link

0 commit comments

Comments
 (0)
Please sign in to comment.