Update README.md

SolidLabResearch · Jan 9, 2025 · da35361 · da35361
1 parent c45dcc3
commit da35361
Showing 1 changed file with 21 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,27 +1,42 @@
 # Bashlib
 This repository contains a suite of functionality to facilitate use and development for Solid
 
-For a tutorial and documentation, see [the documentation website](solidlabresearch.github.io/Bashlib/)
 
-<!--
 ## Requirements
 
 - Node >= 16.0.0
 
 ## Setup
-Using github
+**Using github**
 ``` 
 git clone git@github.com:SolidLabResearch/Bashlib.git
 cd Bashlib
 npm install 
 npm run build
 ```
-
-Using NPM
+After the install, add an alias to your `.bashrc` for convenience:
+```
+alias sld="node /path/to/folder/.../bin/solid.js"
+```
+**Using NPX**
+```
+npx solid-bashlib
+```
+This will automatically install any dependencies.
+You can add an alias to your `.bashrc` for convenience:
 ```
-npm install solid-bashlib
+alias sld="npx solid-bashlib"
 ```
 
+**Note that while more straightforward, using NPX incurs a performance penalty of up to 1 second!
+Consider a github install if you plan to use this tool regularly!**
+
+
+## Documentation
+For a tutorial and documentation, see [the documentation website](solidlabresearch.github.io/Bashlib/)
+
+<!--
+
 ## Synopsis
 
 ```