Added --gist instructions to Readme #20

Author: rimutaka

README.md

@@ -47,7 +47,7 @@ cd stm_app
 cargo run -- --project "path_to_any_of_your_local_projects"
 ```
 
-The app will access `.git` folder inside `path_to_any_of_your_local_projects` directory and create an anonymous profile with your first report on _stackmuncher.com_. Add `--dryrun` flag to generate a report without creating a profile or submitting any data to the Directory. Look at the log printed by the app for details to examine the prepared report.
+The app will access `.git` folder inside `path_to_any_of_your_local_projects` directory and create an anonymous profile with your first report on _stackmuncher.com_. Add `--dryrun` flag to generate a report without creating a profile or submitting any data to the Directory. Look at the log printed by the app for details if you want to examine the prepared report.
 
 The **default config** of the app assumes that it is run on a development machine from the root folder of a repository you made commits to.
 
@@ -83,7 +83,7 @@ Find out what email addresses were used in commits to `xml_to_serde` repo:
 _mx_ and _rimutaka_ are the same person. Let's add both emails to StackMuncher config using `--email` parameter:
 
 ```shell
-~/rust/stm_app$ cargo run -- view_config --emails "[email protected], [email protected]"
+~/rust/stm_app$ cargo run -- config --emails "[email protected], [email protected]"
 
     Primary email: [email protected]
     Commit emails: [email protected], [email protected]
@@ -96,8 +96,7 @@ _mx_ and _rimutaka_ are the same person. Let's add both emails to StackMuncher c
     Code analysis rules: /home/ubuntu/rust/stm_app/stm_rules
     Config file: /home/ubuntu/rust/stm_app/.stm_config/config.json
 ```
-The app stored two emails from `--emails` param in its config file and printed its full config info (`view_config` command). From now on it will look for commits from _[email protected]_ and _[email protected]_.
-
+The app stored two emails from `--emails` param in its config file and printed its full config info (`config` command). From now on it will look for commits from _[email protected]_ and _[email protected]_.
 
 ##  Adding more projects to your profile
 
@@ -122,10 +121,20 @@ Git will invoke the app every time you make a commit to a repo with the post-com
 
 You can skip adding the Git hook and run `stackmuncher` from the root of any of your projects. No additional params are required.
 
+## Making your profile public
+
+Public profiles are searchable by employers looking for software developers. Your public profile will be created with the same login and personal details as your GitHub profile.
+
+E.g. https://stackmuncher.com/rimutaka has _contact details_ and _public projects_ from https://github.com/rimutaka as well as _private projects_ from https://stackmuncher.com/?dev=9PdHabyyhf4KhHAE1SqdpnbAZEXTHhpkermwfPQcLeFK.
+
+1. Run `stackmuncher github`
+2. Use the signature it printed for a private Gist to confirm your GitHub account ownership
+3. Run `stackmuncher config --gist [URL of the Gist]`
+
 ## Using StackMuncher app on multiple machines
 
 1. Clone this repo onto a 2nd machine
-2. Run `cargo run -- view_config` to bootstrap the app
+2. Run `cargo run -- config` to bootstrap the app
 3. Copy-paste the contents of `.stm_config/config.json` and `.stm_config/key.txt` from the 1st to the 2nd machine
 
 The 2nd machine will be connected to the same Developer Profile as the first one for as long as they share the same _key.txt_ file. If you loose the key file the app will generate a new one and create a new Developer Profile. Contact us on [email protected] to merge the old profile into the new one.
@@ -135,7 +144,7 @@ The 2nd machine will be connected to the same Developer Profile as the first one
 Running `stackmuncher` without any additional params generates a report for the project in the current working directory and updates your developer profile.
 
 Anonymous profiles are identified by a public key from the key-pair generated by the app on the first run. E.g. https://stackmuncher.com/?dev=9PdHabyyhf4KhHAE1SqdpnbAZEXTHhpkermwfPQcLeFK
-The key is located in the app's config folder and can be copied to another machine to connect to the same developer profile. Run `stackmuncher view_config` command to see the exact location of the config folder.
+The key is located in the app's config folder and can be copied to another machine to connect to the same developer profile. Run `stackmuncher config` command to see the exact location of the config folder.
 
 ### Additional options
 
@@ -163,7 +172,7 @@ Example:
 
 Example:
 ```shell
-~$ stackmuncher view_config --primary_email "[email protected]" --public_name "rimutaka" --public_contact "[email protected] or https://rimutaka.me"
+~$ stackmuncher config --primary_email "[email protected]" --public_name "rimutaka" --public_contact "[email protected] or https://rimutaka.me"
 
     Primary email: [email protected]
     Commit emails: [email protected], [email protected]
@@ -184,10 +193,10 @@ Example:
 * `--reports "path to reports folder"`: a path to an alternative location for saving stack reports. The path can be relative or absolute. Defaults to the application folder.
 * `--config "path to config folder"`: a path to an alternative location of the config folder. The path can be relative or absolute. Defaults to the application folder.
 
-* `--help`: display usage info
+#### Additional info
 
-#### Additional commands
-* `view_config`: displays the contents of the config file and its location. The config file can be edited manually or copied to another machine together with the key file to connect to the same Developer Profile.
+* `stackmuncher help`: displays usage info
+* `stackmuncher config`: display the contents of the config file and its location. The config file can be edited manually.
 
 ## Limitations
 
@@ -213,7 +222,7 @@ We want to hear about as many issues users run into as possible. Copy-paste the
 **If the app did something, but no report was submitted:**
 
 * look through the log it printed for clues
-* run `stackmuncher view_config` and check the output in `reports` folder - there should be at least 4 files:
+* run `stackmuncher config` and check the output in `reports` folder - there should be at least 4 files:
     * _project_report.json_: includes all contributors 
     * _combined_report.json_: a combined report for authors/committers from Git's `user.email` setting and from `--emails` param
     * _submitted_report.json_: a sanitized version of the combined report exactly as it was submitted to the Directory

stackmuncher/src/app_args.rs

@@ -49,7 +49,7 @@ impl FromStr for AppArgCommands {
         let command = match command.as_str() {
             "help" => Self::Help,
             "" | "munch" => Self::Munch,
-            "viewconfig" | "view-config" | "view_config" | "config" => Self::ViewConfig,
+            "config" => Self::ViewConfig,
             "makeanon" | "make-anon" | "make_anon" => Self::MakeAnon,
             "deleteprofile" | "delete-profile" | "delete_profile" | "delete" => Self::DeleteProfile,
             "github" => Self::GitGHubConfig,
@@ -101,8 +101,6 @@ impl AppArgs {
         // help has a higher priority and should be handled separately
         if pargs.contains(["-h", "--help"]) {
             app_args.command = AppArgCommands::Help;
-        } else if pargs.contains("--view_config") || pargs.contains("--viewconfig") {
-            app_args.command = AppArgCommands::ViewConfig;
         }
 
         // --noupdate param with different misspellings

stackmuncher/src/configure.rs renamed to stackmuncher/src/cmd_config.rs

@@ -50,7 +50,7 @@ pub(crate) async fn github(config: AppConfig) {
     help::emit_gist_instructions(&expected_gist_content);
 }
 
-/// A temporary stub for `view_config` command.
+/// Prints its full current configuration, file locations, profile URL and some usage info.
 pub(crate) async fn view_config(config: AppConfig) {
     // prepare values needed in println!() macros to prevent line wrapping in the code
     let pub_key = ReportSignature::get_public_key(&config.user_key_pair);

stackmuncher/src/config.rs

@@ -240,7 +240,7 @@ impl AppConfig {
         // Otherwise use what is in the cache without any validation.
         let gh_validation_url = if app_args.gh_validation_id.is_some() {
             // --gist was present - so something was requested
-            match crate::configure::get_validated_gist(&app_args.gh_validation_id, &user_key_pair).await {
+            match crate::cmd_config::get_validated_gist(&app_args.gh_validation_id, &user_key_pair).await {
                 Some(gist) => Some(gist.html_url),
                 None => None,
             }

stackmuncher/src/help.rs

@@ -94,8 +94,8 @@ pub(crate) fn emit_key_err_msg(key_file_path: &str) {
         "    2. If you didn't edit {} you can delete it and the app will generate a new one.",
         key_file_path
     );
-    eprintln!("    The side effect of that is that the app will also create a new Developer Profile for you.");
-    eprintln!("    If you think you lost your original key, just delete the file and contact us on [email protected] to link your existing Developer Profile to the new key.");
+    eprintln!("    The side effect of that is that the app will also create a new Directory Profile for you.");
+    eprintln!("    If you think you lost your original key, just delete the file and contact us on [email protected] to link your existing Directory Profile to the new key.");
     eprintln!("    We apologize for not automating this step yet.");
     eprintln!();
 }
@@ -201,7 +201,7 @@ OPTIONS:
 
 MORE INFO:
 
-    stackmuncher{exe_suffix} config                 prints URLs of your Developer Profile and other configuration details
+    stackmuncher{exe_suffix} config                 prints URLs of your Directory Profile and other configuration details
 
     https://stackmuncher.com/about      about the Directory
     https://github.com/stackmuncher     source code, issues and more

stackmuncher/src/main.rs

@@ -3,9 +3,9 @@ use path_absolutize::{self, Absolutize};
 use tracing::info;
 
 mod app_args;
+mod cmd_config;
 mod cmd_munch;
 mod config;
-mod configure;
 mod help;
 mod signing;
 mod submission;
@@ -60,13 +60,13 @@ async fn main() -> Result<(), ()> {
             make_anon();
         }
         app_args::AppArgCommands::ViewConfig => {
-            configure::view_config(config).await;
+            cmd_config::view_config(config).await;
         }
         app_args::AppArgCommands::Help => {
             help::emit_welcome_msg(config);
         }
         app_args::AppArgCommands::GitGHubConfig => {
-            configure::github(config).await;
+            cmd_config::github(config).await;
         }
     };