From 3e4ccb3376b55bbcbd540eb8001cba96f1e7d039 Mon Sep 17 00:00:00 2001 From: stephen mcquay Date: Sat, 24 Feb 2018 20:09:17 -0800 Subject: [PATCH] Describe components that make up the project --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index aa8c3ac..0e76aac 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,16 @@ version *ranges* are not. The project is currently in early design phases, and this document describes the high-level approach of the project. + +## Components + +There are two main components to this project. + +0. `pm` is the name of the client-side cli command. This is the tool used to + fetch, install, verify, create, upload, etc. packages. +0. `pmd` is the name of the server-side component. It hosts packages (over + `http` for now), available package metadata, and cryptographic public key + information to clients. + +Securely installing the `pm` command is important. Be sure to verify its +contents before use.