Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbax189 committed Jul 5, 2024
1 parent a8a892a commit e8e1e3a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ Inspired by the excellent [[https://github.com/silex/docker.el][Docker.el]]

** Install

No specific configuration. Simply install from this repo:
No specific configuration. Simply install from this repo.

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

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

Other commands
- =M-x npm-manager-search= like =npm search= with more info and features exposed
- =M-x npm-manager-info= run =npm info= on the listed package
[[./images/npm-manager-main.png]]
/Running npm-manager in a project directory/

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.
You can install packages directly from search results too.

[[./images/npm-manager-search.png]]
/Searching for typescript package/

*** Planned Features
- support pnpm and yarn
- inspect audit reports interactively

** Changelog

*** 0.1
- npm-manager: list packages and warnings
- npm-manager-search: search registry and install packages
Binary file added images/npm-manager-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/npm-manager-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e8e1e3a

Please sign in to comment.