Notes on dist files [ci skip]

protobufjs · Nov 29, 2016 · 6376983 · 6376983
1 parent 4affa1b
commit 6376983
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/dist/README.md b/dist/README.md
@@ -0,0 +1,17 @@
+This folder contains prebuilt browser versions of [protobuf.js](https://github.com/dcodeIO/protobuf.js). When sending pull requests, it is not required to update these.
+
+Prebuilt files are in source control to enable pain-free CDN usage through [RawGit](http://rawgit.com/):
+
+Development:
+
+```
+<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.0.0/dist/protobuf.js"></script>
+```
+
+Production:
+
+```
+<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.0.0/dist/protobuf.min.js"></script>
+```
+
+**NOTE:** Remember to replace the version tag with the exact [release](https://github.com/dcodeIO/protobuf.js/releases) your project depends upon.