From 746e038f7962d825c4b4081f104a4d6ed597b169 Mon Sep 17 00:00:00 2001 From: Daniel Mathiot Date: Tue, 11 Jan 2022 10:33:15 +0100 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 686c246..87f0170 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,17 @@ use { ## Usage -I exposed a function to generate the annotations. +- If you want to keep it simple, you can use the `:Neogen` command: + +```vim +" will generate annotation for the function you're inside +:Neogen +" or you can force a certain type of annotation. It'll find the next upper node that matches the type +" E.g if you're on a method of a class and do :Neogen class, it'll find the class declaration and generate the annotation. +:Neogen func|class|type|... +``` + +- If you like to use the lua API, I exposed a function to generate the annotations. ```lua require('neogen').generate()