aboutsummaryrefslogtreecommitdiff
path: root/atom/packages/vim-mode/node_modules/grim/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'atom/packages/vim-mode/node_modules/grim/README.md')
-rw-r--r--atom/packages/vim-mode/node_modules/grim/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/atom/packages/vim-mode/node_modules/grim/README.md b/atom/packages/vim-mode/node_modules/grim/README.md
new file mode 100644
index 0000000..c7a023c
--- /dev/null
+++ b/atom/packages/vim-mode/node_modules/grim/README.md
@@ -0,0 +1,21 @@
+# Grim [![Build Status](https://travis-ci.org/atom/grim.svg)](https://travis-ci.org/atom/grim)
+
+Log deprecate calls
+
+## Installing
+
+```sh
+npm install grim
+```
+
+## Usage
+
+```javascript
+Grim = require('grim')
+
+function someOldMethod() {
+ Grim.deprecate("Use theNewMethod instead.")
+}
+```
+
+To view all calls to deprecated methods use `Grim.logDeprecations()` or get direct access to the deprecated calls by using `Grim.getDeprecations()`