Skip to content

Commit

Permalink
start of adding package docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ellman committed Nov 3, 2014
1 parent b4ffde6 commit bcfb6b4
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,19 @@ To create a new MEAN app, run <code>mean init</code>. Name for the application i
```

## Packages

Everything in mean.io is a package and when extending mean with custom functionality make sure you create your own package and do not alter the core packages.

The mean.io package system allows developers to create modular code that provides useful tools that other mean developers can use. The packages, when published, are plug-and-play and are used in a way very similar to traditional npm packages.

The meanio package system integrates all the packages into the mean project as if the code was part of mean itself and provides the developers with all the necceesary tools required to integrate their package into the host project.

There are two types of packages:

**Custom Packages** are generated by the mean scaffolder and contain most of your application logic. Custom packages are found in /packages and can be published as a contrib package for use by other developers.

**Contrib Packages** are installed by the mean installer and are found at /node_modules. Contrib packages are "plug and play".

### Core Packages
#### System
coming soon
Expand Down

0 comments on commit bcfb6b4

Please sign in to comment.