Merge pull request #179 from stephengtuggy/update-license-2024

Update Documentation

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2022 Stephen G Tuggy
+Copyright (c) 2018-2024 Stephen G. Tuggy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,29 +4,29 @@
 
 ## Overview
 
-This is a web app that lets you enter info about your current and past jobs into a database. You can then view this info later on, when you need to fill out a job application. This way, you won't have to remember everything every time. And you can refine the wording on, for example, your "Contributions and Accomplishments" section over time.
+This is a web app that lets you enter information about your current and past jobs into a database. You can then refer to this information later on, when you need to fill out a job application. This way, you won't have to remember everything every time. And over time, you can refine the wording on, for example, your "Contributions and Accomplishments" section.
 
 ## Prerequisites
 
-This app runs in `Docker`. You will need both Docker and Docker Compose to build and run it. On macOS and Windows, the easiest way to get these products is to download and install Docker Desktop Community Edition.
+This app runs in `Docker`. You will need Docker to build and run it. The process for installing Docker varies between platforms. You should use a recent-enough version of Docker that it comes bundled with Docker Compose.
 
-Also, you will need a copy of a file called `.env`. Place this file in the root folder of your local working copy of this repo. You can use `.env.example` as a reference/template. Be sure to change the values for `JOB_HISTORY_SECRET_KEY`, `JOB_HISTORY_DB_PASSWORD`, and `POSTGRES_PASSWORD`. (The last two values should match.)
+Also, you will need a copy of a file called `.env`. Place this file in the root folder of your local working copy of this repository. You can use `.env.example` as a template. Be sure to set the value for `JOB_HISTORY_SECRET_KEY`, ideally to a high-quality password generated by a password generator.
 
-Once you have these items in place, run the command `docker-compose up --build`, either in PowerShell on Windows, or in Terminal on macOS or Linux. You should see Docker Compose pulling the latest copy of each source docker image, then building the main image for this app, and finally, spinning up both containers.
+Once you have these items in place, run the command `docker compose up --build`, either in PowerShell on Windows, or in Terminal on macOS or Linux. You should see Docker Compose pulling the latest copy of the source Docker image, then building this application's Docker image based on that, and finally, spinning up the container.
 
 Assuming that this command completes successfully, you can now open your favorite web browser, and enter the URL: [http://localhost:8000/administrate/](http://localhost:8000/administrate/). Oh, wait. The first time you run this app, you will need to create a user account for yourself. To do so, open another PowerShell / Terminal window in the `app` folder, and run this sequence of commands, one at a time:
 
 ```sh
-docker-compose exec web bash
+docker compose exec web sh
 ./manage.py createsuperuser
 exit
 ```
 
-After the createsuperuser command, follow the prompts to set up your first user account / login. You should then be able to log in at [the above URL](http://localhost:8000/administrate/). From that point, you can create other user accounts if you wish using the web UI.
+After the createsuperuser command, follow the prompts to set up your first user account. You should then be able to log in at [the above URL](http://localhost:8000/administrate/). From that point, you can create other user accounts if you wish using the web UI.
 
 ## Use
 
-Now, down to business. Under `JOB HISTORY`, click on `EMPLOYERS`, and enter your employers, one at a time. (Employers that you have worked for in the past ten years is probably sufficient.)
+Now, down to business. Under `JOB HISTORY`, click on `EMPLOYERS`, and enter your employers, one at a time. (Entering the employers that you have worked for in the past ten years is probably sufficient.)
 
 Finally, click on the `JOB HISTORY` breadcrumb; click on `POSITIONS`; and start entering the positions you have held at each employer, along with the time periods for each.