summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/util/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'frontend-old/node_modules/@firebase/util/README.md')
-rw-r--r--frontend-old/node_modules/@firebase/util/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/util/README.md b/frontend-old/node_modules/@firebase/util/README.md
new file mode 100644
index 0000000..b79aeb6
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/util/README.md
@@ -0,0 +1,25 @@
+# @firebase/util
+
+_NOTE: This is specifically tailored for Firebase JS SDK usage, if you are not a
+member of the Firebase team, please avoid using this package_
+
+This is a wrapper of some Webchannel Features for the Firebase JS SDK.
+
+## Usage
+
+**ES Modules**
+
+```javascript
+import { Deferred } from '@firebase/util';
+
+// Do stuff with Deferred or any of the other Utils you import
+```
+
+**CommonJS Modules**
+
+```javascript
+const utils = require('@firebase/util');
+
+// Do stuff with any of the re-exported `utils`
+```
+