Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dongryphon committed May 12, 2017
1 parent e07add5 commit 49c0699
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions README.md
@@ -1,15 +1,40 @@
# package-loader
Ext JS Dynamic Package Loader

# Install
# Requirements
This package is used by Ext JS applications and Sencha Cmd 6.5

- Install [Sencha Cmd](https://www.sencha.com/products/extjs/cmd-download/) (^6.5.0)
- Download [Sencha Ext JS](https://www.sencha.com/products/extjs) (^6.5.0). We
- Install [Sencha Cmd](https://www.sencha.com/products/sencha-cmd/)
- Download [Sencha Ext JS](https://www.sencha.com/products/extjs). We
recommend extracting Ext JS into a `"sencha-sdks"` folder in your home directory.
- Setup the framework for the package
$ sencha workspace install ~/sencha-sdks

## Use In Cmd Application
Simply add `package-loader` to the `'app.json'` file's `requires` array:

"requires": [
"package-loader"
]

Then build the application

sencha app build --dev

The `package-loader` package will be automatically downloaded from Sencha's CDN.

# Manual Installation

In most cases you won't need to manually install this package. If you cannot access
the Sencha CDN as part of the app build, you can manually download the files to
your workspace.

Be sure that the `'packages/package-loader'` path is placed in the correct root of
your application or workspace.

# Build

Should you want to build the package yourself, first you will need to setup the
workspace which will need a local copy of Ext JS to build:

$ sencha workspace install ~/sencha-sdks
$ cd packages/package-loader
$ sencha package build
$ sencha package build

0 comments on commit 49c0699

Please sign in to comment.