diff --git a/docs/README.md b/docs/README.md index db94d57a381a..d5d3468f760d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,7 @@ * [Quick start](tutorial/quick-start.md) * [Application distribution](tutorial/application-distribution.md) +* [Application packaging](tutorial/application-packaging.md) * [Using native node modules](tutorial/using-native-node-modules.md) * [Debugging browser process](tutorial/debugging-browser-process.md) * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md) diff --git a/docs/tutorial/application-distribution.md b/docs/tutorial/application-distribution.md index cba702c42268..72d78bc9b253 100644 --- a/docs/tutorial/application-distribution.md +++ b/docs/tutorial/application-distribution.md @@ -27,7 +27,19 @@ Then execute `Atom.app` (or `atom` on Linux, and `atom.exe` on Windows), and atom-shell will start as your app. The `atom-shell` directory would then be your distribution that should be delivered to final users. -## Build with grunt +## Packaging your app into a file + +Apart from shipping your app by copying all its sources files, you can also +package your app into [asar](https://github.com/atom/asar) archive to avoid +exposing your app's source code to users. + +To use the `asar` archive to replace the `app` folder, you need to rename the +archive to `app.asar`, and put it under atom-shell's resources directory, +atom-shell will then try read the archive and start from it. + +More details can be found in [Application packaging](application-packaging.md). + +## Building with grunt If you build your application with `grunt` there is a grunt task that can download atom-shell for your current platform automatically: diff --git a/docs/tutorial/application-packaging.md b/docs/tutorial/application-packaging.md new file mode 100644 index 000000000000..d46cd2226660 --- /dev/null +++ b/docs/tutorial/application-packaging.md @@ -0,0 +1 @@ +# Application packaging