Skip to content

Commit f634390

Browse files
Doc++
1 parent 25095be commit f634390

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
# NativeScript plugin for CodePush
22

3-
This plugin provides client-side integration for the [CodePush service](http://codepush.tools),
4-
allowing you to easily add a dynamic update experience to your NativeScript app(s).
5-
6-
> BEWARE: Sometime June 2017 it is expected you can no longer create new CodePush apps anymore. Apps created beforehand will continue to work for the foreseeable future though. The exact date? Unknown, but you'll notice when trying to create an app with the CodePush CLI.
7-
8-
> UPDATE june 19 2017: The aforementioned change has been made; sadly no new CodePush NativeScript apps can be created. See [this issue](https://github.com/Microsoft/code-push/pull/435) for details.
9-
10-
> 📣 📣 📣 UPDATE may 9 2019: we're considering rebooting our efforts. Stay tuned!
11-
123
[![Build Status][build-status]][build-url]
134
[![NPM version][npm-image]][npm-url]
145
[![Downloads][downloads-image]][npm-url]
@@ -22,17 +13,21 @@ allowing you to easily add a dynamic update experience to your NativeScript app(
2213
[twitter-image]:https://img.shields.io/twitter/follow/eddyverbruggen.svg?style=social&label=Follow%20me
2314
[twitter-url]:https://twitter.com/eddyverbruggen
2415

25-
## How does it work?
16+
<details>
17+
<summary>How does it work? (optional reading)</summary>
18+
2619
A NativeScript app is composed of XML/HTML, CSS and JavaScript files and any accompanying images, which are bundled together by the NativeScript CLI and distributed as part of a platform-specific binary (i.e. an .ipa or .apk file). Once the app is released, updating either the code (e.g. making bug fixes, adding new features) or image assets, requires you to recompile and redistribute the entire binary, which of course, includes any review time associated with the store(s) you are publishing to.
2720

2821
The CodePush plugin helps get product improvements in front of your end users instantly, by keeping your code and images synchronized with updates you release to the CodePush server. This way, your app gets the benefits of an offline mobile experience, as well as the "web-like" agility of side-loading updates as soon as they are available. It's a win-win!
2922

3023
In order to ensure that your end users always have a functioning version of your app, the CodePush plugin maintains a copy of the previous update, so that in the event that you accidentally push an update which includes a crash, it can automatically roll back. This way, you can rest assured that your newfound release agility won't result in users becoming blocked before you have a chance to roll back on the server. It's a win-win-win!
3124

32-
_To confuse you even more, have a diagram of the bits involved in this solution:_
33-
3425
<img src="https://github.com/EddyVerbruggen/nativescript-code-push/raw/master/media/NativeScript%20CodePush%20landscape.png" width="570px" height="508px">
3526

27+
_Architectural overview of the solution - you don't need to worry about all of this_
28+
29+
</details>
30+
3631
### What can (and will) be CodePushed?
3732
- Anything inside your `/app` folder.
3833
- Anything inside your `/node_modules` folder.

0 commit comments

Comments
 (0)