Merge pull request #117 from emacs-php/keybinding-readme

add notice about keybindings + example using transient.el

README.org

@@ -48,6 +48,40 @@ Alternatively, you can install Phpactor on your own and configure `phpactor-exec
 *** phpactor itself
 See https://phpactor.github.io/phpactor/configuration.html
 
+*** keybindings
+
+Phpactor.el doesn't bring any keybindings and it's up to you to configure them as you wish.
+
+You could for example limit yourself to only one by using [[https://github.com/magit/transient][transient.el]] like this
+
+#+BEGIN_SRC elisp
+(define-transient-command php-transient-menu ()
+  "Php"
+  [["Class"
+    ("cc" "Copy" phpactor-copy-class)
+    ("cn" "New" phpactor-create-new-class)
+    ("cr" "Move" phpactor-move-class)
+    ("ci" "Inflect" phpactor-inflect-class)
+    ("n"  "Namespace" phpactor-fix-namespace)]
+   ["Properties"
+    ("a"  "Accessor" phpactor-generate-accessors)
+    ("pc" "Constructor" phpactor-complete-constructor)
+    ("pm" "Add missing props" phpactor-complete-properties)
+    ("C"  "Extract const" phpactor-extract-constant)
+    ("r" "Rename var locally" phpactor-rename-variable-local)
+    ("R" "Rename var in file" phpactor-rename-variable-file)]
+  ["Methods"
+    ("i" "Implement Contracts" phpactor-implement-contracts)
+    ("m"  "Generate method" phpactor-generate-method)]
+  ["Navigate"
+    ("x" "List refs" phpactor-list-references)
+    ("X" "Replace refs" phpactor-replace-references)
+    ("."  "Goto def" phpactor-goto-definition)]
+  ["Phpactor"
+    ("s" "Status" phpactor-status)
+    ("u" "Install" phpactor-install-or-update)]])
+#+END_SRC
+
 ** Troubleshooting
 
 You can run ``phpactor-status`` while visiting a project file.