Skip to content

Commit e8e1e3a

Browse files
committed
Update readme
1 parent a8a892a commit e8e1e3a

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

README.org

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ Inspired by the excellent [[https://github.com/silex/docker.el][Docker.el]]
77

88
** Install
99

10-
No specific configuration. Simply install from this repo:
10+
No specific configuration. Simply install from this repo.
1111

12+
E.g. using =straight=
1213
#+begin_src emacs-lisp
1314
(use-package npm-manager
1415
:straight (npm-manager :fetcher git :url "https://github.com/joshbax189/npm-manager-el"))
@@ -20,6 +21,21 @@ From anywhere in a node project, run =M-x npm-manager=
2021

2122
This will list packages from the project's package.json sorted by type, with installed version and any warnings raised by =npm audit=
2223

23-
Other commands
24-
- =M-x npm-manager-search= like =npm search= with more info and features exposed
25-
- =M-x npm-manager-info= run =npm info= on the listed package
24+
[[./images/npm-manager-main.png]]
25+
/Running npm-manager in a project directory/
26+
27+
Run =M-x npm-manager-search= to search the NPM registry for packages. This is like =npm search= with more info and features exposed, including quality and popularity ratings.
28+
You can install packages directly from search results too.
29+
30+
[[./images/npm-manager-search.png]]
31+
/Searching for typescript package/
32+
33+
*** Planned Features
34+
- support pnpm and yarn
35+
- inspect audit reports interactively
36+
37+
** Changelog
38+
39+
*** 0.1
40+
- npm-manager: list packages and warnings
41+
- npm-manager-search: search registry and install packages

images/npm-manager-main.png

26.1 KB
Loading

images/npm-manager-search.png

208 KB
Loading

0 commit comments

Comments
 (0)