Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(398)

Unified Diff: pkg/js/README.md

Issue 1318043005: Support user generated custom native JS classes. (Closed) Base URL: git@github.com:dart-lang/sdk.git@master
Patch Set: about to land Created 5 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « pkg/js/PATENTS ('k') | pkg/js/lib/js.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/js/README.md
diff --git a/pkg/js/README.md b/pkg/js/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d27b6eb94ec6d899afebfacf354adc3ca21faf3c
--- /dev/null
+++ b/pkg/js/README.md
@@ -0,0 +1,60 @@
+Dart-JavaScript Interop
+=======================
+
+Status
+------
+
+Version 0.6.0 is a complete rewrite of package:js
+
+The package now only contains annotations specifying the shape of the
+JavaScript API to import into Dart.
+The core implementation is defined directly in Dart2Js, Dartium, and DDC.
+
+**Warning: support in Dartium and Dart2Js is still in progress.
+
+#### Example - TODO(jacobr)
+
+Configuration and Initialization
+--------------------------------
+
+### Adding the dependency
+
+Add the following to your `pubspec.yaml`:
+
+```yaml
+dependencies:
+ js: ">=0.6.0 <0.7.0"
+```
+
+##### main.html
+
+```html
+<html>
+ <head>
+ </head>
+ <body>
+ <script type="application/dart" src="main.dart"></script>
+ </body>
+</html>
+```
+
+##### main.dart
+
+TODO(jacobr): example under construction.
+```dart
+library main;
+
+import 'package:js/js.dart';
+
+main() {
+}
+```
+
+Contributing and Filing Bugs
+----------------------------
+
+Please file bugs and features requests on the Github issue tracker: https://github.com/dart-lang/js-interop/issues
+
+We also love and accept community contributions, from API suggestions to pull requests. Please file an issue before beginning work so we can discuss the design and implementation. We are trying to create issues for all current and future work, so if something there intrigues you (or you need it!) join in on the discussion.
+
+All we require is that you sign the Google Individual Contributor License Agreement https://developers.google.com/open-source/cla/individual?csw=1
« no previous file with comments | « pkg/js/PATENTS ('k') | pkg/js/lib/js.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698