diff --git a/bin/harper.ts b/bin/harper.ts index baa6edd20..2e65317a3 100644 --- a/bin/harper.ts +++ b/bin/harper.ts @@ -18,6 +18,8 @@ Usage: harperdb [command] With no command, harper will simply run Harper (in the foreground) +Documentation: https://docs.harperdb.io/ + By default, the CLI also supports certain Operation APIs. Specify the operation name and any required parameters, and omit the 'operation' command. Commands: diff --git a/static/README.md b/static/README.md index 9d100c5a0..c3df73214 100644 --- a/static/README.md +++ b/static/README.md @@ -1,13 +1,14 @@ # Harper -Harper is an open-source Node.js performance platform that unifies database, cache, application, and messaging layers into one in-memory process. +This directory contains the files used by a local Harper installation. -## Harper Filesystem Structure +## Directory Guide -- `harper` - This is the root folder for Harper. It contains all the files and folders that Harper uses. -- `harper/harper-config.yaml` - This is the configuration file, It contains all the settings for Harper. This file is read by Harper when it starts up. It is also written to when you change settings through the API. -- `harper/database` - This folder is the default location for all your database files (that contain the actual data in your databases). -- `harper/keys` - This folder contains the private keys (and can also have certificates) for your PKI/TLS. -- `harper/components` - This folder contains editable components that are stored in Harper. This folder is intended for components that are edited and canonically stored on this server. The standard approach for components is that they are deployed from npm or GitHub and installed to the `hdb/components` directory, then symlinked to the `node_modules/` folder for dependency resolution purposes. -- `harper/log` - This folder contains the log file for Harper -- `harper/backup` - This folder contains backup copies for files when they are modified. When harper-config.yaml is modified through the API, previous versions are stored here. +- `harper-config.yaml` - Local configuration read by Harper at startup and updated when settings change through the API. +- `backup/` - Backup copies of files Harper updates, such as previous `harper-config.yaml` versions. +- `components/` - Editable local components stored on this server. +- `database/` - Default location for database storage files. +- `keys/` - Private keys and certificates used for PKI/TLS. +- `log/` - Harper log output. + +For installation, configuration, and API documentation, see https://docs.harperdb.io/.