add docs

Author: kaiosilveira

README.md

@@ -1,28 +1,11 @@
 [![Continuous Integration](https://github.com/kaiosilveira/replace-constructor-with-factory-function-refactoring/actions/workflows/ci.yml/badge.svg)](https://github.com/kaiosilveira/replace-constructor-with-factory-function-refactoring/actions/workflows/ci.yml)
 
-# Refactoring catalog repository template
-
-This is a quick template to help me get a new refactoring repo going.
-
-## Things to do after creating a repo off of this template
-
-1. Run `GITHUB_TOKEN=$(gh auth token) yarn tools:cli prepare-repository -r <repo_name>`. It will:
-
-- Update the `README.md` file with the actual repository name, CI badge, and commit history link
-- Update `package.json` with the repository's name and remote URL
-- Update the repo's homepage on GitHub with:
-  - A description
-  - A website link to https://github.com/kaiosilveira/refactoring
-  - The following labels: javascript, refactoring, replace-constructor-with-factory-function-refactoring
-
-2. Replace the lorem ipsum text sections below with actual text
-
 ## Useful commands
 
 - Generate markdown containing a diff with patch information based on a range of commits:
 
 ```bash
-yarn tools:cli generate-diff -f <first_commit_sha> -l <last_commit_sha>
+yarn tools:cli generate-diff -f 6f90103 -l HEAD
 ```
 
 - To generate the commit history table for the last section, including the correct links:
@@ -119,10 +102,10 @@ And that's it!
 
 Below there's the commit history for the steps detailed above.
 
-| Commit SHA                                                                  | Message                  |
-| --------------------------------------------------------------------------- | ------------------------ |
+| Commit SHA                                                                                                      | Message                  |
+| --------------------------------------------------------------------------------------------------------------- | ------------------------ |
 | [cmt-sha-1](https://github.com/kaiosilveira/replace-constructor-with-factory-function-refactoring/commit-SHA-1) | description of commit #1 |
 | [cmt-sha-2](https://github.com/kaiosilveira/replace-constructor-with-factory-function-refactoring/commit-SHA-2) | description of commit #2 |
 | [cmt-sha-n](https://github.com/kaiosilveira/replace-constructor-with-factory-function-refactoring/commit-SHA-n) | description of commit #n |
 
-For the full commit history for this project, check the [Commit History tab](https://github.com/kaiosilveira/replace-constructor-with-factory-function-refactoring/commits/main).
+For the full commit history for this project, check the [Commit History tab](https://github.com/kaiosilveira/replace-constructor-with-factory-function-refactoring/commits/main).