Skip to content

Commit 75d693a

Browse files
committed
Reorganize README with clearer messaging and calls to action
Closes NativeScript#1493
1 parent 630daa0 commit 75d693a

1 file changed

Lines changed: 52 additions & 69 deletions

File tree

README.md

Lines changed: 52 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,53 @@
1-
[![Build Status](https://travis-ci.org/NativeScript/NativeScript.svg)](https://travis-ci.org/NativeScript/NativeScript)
2-
# Welcome to the NativeScript framework repository
3-
4-
## What is the NativeScript framework
5-
6-
With the NativeScript framework you can use your JavaScript and CSS skills to write native mobile applications for [iOS](https://www.apple.com/ios/), [Android](https://www.android.com/) and (soon) [Windows Phone](http://www.windowsphone.com/en-us). There is no *WebView* involved in rendering the app, as the UI is rendered by the native platform's rendering engine. Because of that, the app's entire UX **is** native.
7-
8-
The NativeScript framework enables you to use a complete stack of cross-platform APIs to write your application code or, if you need to, you can directly access all platform-specific native APIs using JavaScript only. That’s right—you can access all native APIs, not only the ones we thought would be useful!
9-
10-
We did not want to create just yet another ecosystem around a native cross-platform framework. We wanted to integrate and play well with all existing JavaScript and native iOS/Android/Windows ecosystems. That is why we also support using existing JavaScript libraries, as well as existing native Objective-C, Java and .NET libraries. We want to stress that you *don't need to know Objective-C, Java or .NET* in order to reuse these libraries—their entire APIs are available in JavaScript with no changes.
11-
12-
Because of the features listed above you get some important functionality right out of the box. The first is that applications built using the NativeScript framework support the same accessibility models as native apps. This is important for anyone creating apps that need to meet certain accessibility standards before going live. This is also very useful when you start implementing functional or unit tests for your app. Several existing cross-platform tools like [Appium](http://www.appium.io) already work directly with the NativeScript framework and provide accessibility automation.
13-
14-
The second major feature you get out of the box is 0-day support for new native platforms. Because the NativeScript framework exposes unmodified native APIs and UI components, you can use the latest native APIs and new UI components when Apple, Google or Microsoft updates their mobile platforms.
15-
16-
So let’s summarize what the NativeScript framework enables you as of today:
17-
18-
- Build 100% native cross-platform apps, with a declarative UI, and the ability to implement platform-specific UIs.
19-
- Share 100% of your code or use platform-specific APIs, depending on the app you’re building.
20-
- Code in standards-based ECMAScript 5 JavaScript. ES6 support is coming soon.
21-
- Use standards-based CSS syntax for styling.
22-
- Use rich data binding and existing UI patterns to easily build complex user interfaces.
23-
- Reuse any native library available in Objective-C, Java or .NET.
24-
- Reuse any JavaScript library that is not browser-dependent.
25-
- Reuse the QA tools for accessibility automation to write tests.
26-
- Use the latest native platform features to create an amazing native user experience.
27-
- Code in any IDE of your choice to implement your applications’ code using the [NativeScript framework's CLI](http://npmjs.org/nativescript).
28-
- Use [Telerik Platform](http://platform.telerik.com) and AppBuilder products and the full Visual Studio integration to get a rich development experience. Paid support is also available.
29-
30-
We hope this gives you a good idea about what you can expect from the NativeScript framework.
31-
32-
To learn more about the NativeScript framework, you can check the following resources:
33-
34-
- [The NativeScript framework web site](http://www.nativescript.org)
35-
- [The NativeScript framework blog](http://www.nativescript.org/blog)
36-
37-
## Angular 2.0
38-
NativeScript is working together with the Google Angular JS team to make Angular 2.0 work on top of NativeScript. To check our progress please see the following links
39-
- **[NativeScript Angular 2.0 plugin](https://www.npmjs.com/package/nativescript-angular)** - This plugin is the only thing you need to install in order to enable Angular 2.0 in NativeScript
40-
- **[TodoMVC sample](//github.com/NativeScript/sample-ng-todomvc)** - The classic TodoMVC sample implemented with NativeScript and Angular 2.0
41-
42-
## Most popular repositories:
43-
- **[The current repo](//github.com/NativeScript/NativeScript/)** - Stores the code of the cross-platform modules, written in TypeScript
44-
- **[iOS Runtime](//github.com/NativeScript/ios-runtime/)** - Holds the runtime, allowing the JavaScript code of your application to be executed on an iOS device
45-
- **[Android Runtime](//github.com/NativeScript/android-runtime)** - Holds the runtime, allowing the JavaScript code of your application to be executed on an Android device
46-
- **[NativeScript CLI](//github.com/NativeScript/nativescript-cli)** - Contains the Command-Line Interface for creating an application using the NativeScript framework
47-
- **[Docs](//github.com/NativeScript/docs)** - Contains the NativeScript framework documentation (available on http://docs.nativescript.org/) in MarkDown format
48-
- **[TelerikNEXT conference app](//github.com/NativeScript/sample-TelerikNEXT)** - Stores the code of a complete sample application using user authentication and cloud storage.
49-
- **[Hello-World Template](//github.com/NativeScript/template-hello-world)** - Contains the code of the application the CLI creates by default
50-
51-
## Getting Started and How to Install the NativeScript framework
52-
Please follow this [article to get started with the NativeScript framework](http://docs.nativescript.org/getting-started).
53-
54-
## Documentation
55-
Comprehensive documentation is available at [docs.nativescript.org](http://docs.nativescript.org).
56-
57-
## Supported npm modules
58-
List of supported npm modules is available at [supported-npm-modules](https://github.com/NativeScript/NativeScript/wiki/supported-npm-modules).
59-
60-
## Helping us to improve the NativeScript framework
61-
We love PRs! Please follow our [contribution guide](https://www.nativescript.org/contribute) if you want to become part of the project.
62-
63-
## Contact info
64-
- **Web site** - [http://nativescript.org](http://www.nativescript.org)
65-
- **Twitter** - [@NativeScript](http://twitter.com/NativeScript)
66-
- **Blog** - [http://nativescript.org/blog](http://www.nativescript.org/blog)
67-
- **Forum** - [General discussion](https://groups.google.com/forum/#!forum/nativescript)
68-
- **StackOverflow** - [http://stackoverflow.com/questions/tagged/nativescript](http://stackoverflow.com/questions/tagged/nativescript)
69-
- **IRC Chatroom** - [http://webchat.freenode.net/?channels=nativescript](http://webchat.freenode.net/?channels=nativescript)
1+
# NativeScript [![Build Status](https://travis-ci.org/NativeScript/NativeScript.svg)](https://travis-ci.org/NativeScript/NativeScript)
2+
3+
![NativeScript logo](http://i.imgur.com/YmNIMqS.png)
4+
5+
[NativeScript](http://www.nativescript.org) is a framework for building native iOS and Android apps using JavaScript and CSS. NativeScript renders UIs with the native platform’s rendering engine—no [WebViews](http://developer.telerik.com/featured/what-is-a-webview/)—resulting in native-like performance and UX.
6+
7+
NativeScript provides a best-of-both-worlds development experience. Our cross-platform JavaScript modules give you the convenience of writing iOS and Android apps from a single JavaScript codebase, while our runtimes give you the power of accessing native APIs, SDKs, and frameworks when you need them—all without needing to open Xcode or Android Studio. NativeScript was created and is supported by [Telerik](http://www.telerik.com/).
8+
9+
You can read more about [why NativeScript may be a good fit for your next project](https://github.com/NativeScript/NativeScript/wiki/Why-NativeScript%3F), or check out the links below to get started.
10+
11+
* [Getting Started and Installation](#getting-started-and-installation)
12+
* [Quick Links](#quick-links)
13+
* [Repositories](#repositories)
14+
* [Contributing](#contributing)
15+
* [Angular 2](#angular-2)
16+
17+
## Getting Started and Installation
18+
19+
Our [Getting Started Guide](http://docs.nativescript.org/start/getting-started) is a hands-on tutorial that walks you through installing NativeScript and building a real iOS and Android application.
20+
21+
## Quick Links
22+
23+
- [NativeScript’s home page](http://nativescript.org)
24+
- [NativeScript’s documentation](http://docs.nativescript.org/)
25+
- [@NativeScript on Twitter](http://twitter.com/NativeScript)
26+
- [NativeScript’s blog](http://nativescript.org/blog)
27+
- [NativeScript’s community forum](https://groups.google.com/forum/#!forum/nativescript)
28+
- [NativeScript on Stack Overflow](http://stackoverflow.com/questions/tagged/nativescript)
29+
30+
## Repositories
31+
32+
The NativeScript framework is made up a number of components, all of which are open source and on GitHub. Here are the major ones:
33+
34+
- [The current repo](//github.com/NativeScript/NativeScript/) contains the code of the [NativeScript cross-platform modules](http://docs.nativescript.org/core-concepts/modules), which abstract iOS and Android APIs into JavaScript APIs—e.g. `camera.takePicture()`. The modules are written in TypeScript.
35+
- The [iOS Runtime repo](//github.com/NativeScript/ios-runtime/) contains the code that hosts the iOS app, and allows the JavaScript code of your application to be executed on an iOS device. The iOS runtime is written in a fun mix of C++, Objective-C, and more.
36+
- The [Android Runtime repo](//github.com/NativeScript/android-runtime) contains the code that hosts the Android app, and allows that JavaScript code of your application to be executed on an Android device. The Android runtime is written an even more fun mix of C++ and Java.
37+
- The [NativeScript CLI repo](//github.com/NativeScript/nativescript-cli) contains the command-line interface for creating an application using the NativeScript framework. The CLI is written in TypeScript.
38+
- The [NativeScript Docs repo](//github.com/NativeScript/docs) contain the NativeScript framework documentation which is available on <http://docs.nativescript.org/>. The docs are written in Markdown.
39+
40+
In addition to the code that makes up the NativeScript framework itself, we also provide a number of [open-source sample apps](https://www.nativescript.org/app-samples-with-code) that you can reference while building your NativeScript application.
41+
42+
## Contributing
43+
44+
We love PRs, and accept them for all of our repositories—even docs! Please follow our [contribution guide](https://www.nativescript.org/contribute) if you want to become part of the project.
45+
46+
## Angular 2
47+
48+
We are [working together with the Google Angular JS team](http://angularjs.blogspot.com/2015/12/building-mobile-apps-with-angular-2-and.html) to make Angular 2.0 work on top of NativeScript. To check our progress please see the following links:
49+
50+
- [NativeScript Angular 2.0 plugin](https://www.npmjs.com/package/nativescript-angular) - This plugin is the only thing you need to install in order to enable Angular 2.0 in NativeScript.
51+
- [TodoMVC sample](//github.com/NativeScript/sample-ng-todomvc) - The classic TodoMVC sample implemented with NativeScript and Angular 2.0.
52+
7053
![](https://ga-beacon.appspot.com/UA-111455-24/nativescript/nativescript?pixel)

0 commit comments

Comments
 (0)