diff --git a/README.md b/README.md index c4f44b9..47941e3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ A modular Perl shell with SQLite command history and environment variables. +## Notes + +No job control, but that is what programs like tmux are for anyway. Fairly, basic shell, but modular. This does depend on some modules. Also still a work in progress. + +## Dependencies + +- DBI +- DBD::SQLite +- Term::ReadLine +- Cwd +- File::HomeDir +- Environment::SQLite (for environment variables, part of the source) +- History::SQLite (for command history, part of the source) + +If they are not marked as part of the source for the shell, you will need to install them manually. Via cpan or your package manager. + ## Features - Executes shell commands @@ -31,3 +47,4 @@ A modular Perl shell with SQLite command history and environment variables. - Type commands as you would in a normal shell - Type 'exit' to quit - Command history is stored in `pshell_history.db` +- Environment variables are stored in `pshell_env.db`