From a9875abc53ea67507b5aaa2772bbf411e7bd66d5 Mon Sep 17 00:00:00 2001 From: Caryl Wyatt Date: Fri, 26 Jul 2024 09:16:58 -0500 Subject: [PATCH] fix table of contents --- README.md | 64 ++++++++----------------------------------------------- 1 file changed, 9 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 4ea86a0..6fb28ca 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,23 @@ -# NEW - -
-

- Quick and Easy General Template -
-
- Report Bug - - - Request Feature -

- - +# firebird-common ## Table Of Contents -* [About the Project](#about-the-project) +* [About](#about) * [Built With](#built-with) -* [Phases](#phases) * [Project Set Up](#project-set-up) * [Prerequisites](#prerequisites) * [Installation](#installation) * [Creating A Pull Request](#creating-a-pull-request) * [Content Structure](#content-structure) * [Project Structure](#project-structure) - * [Site Maps](#site-maps) * [Design](#design) * [Functionality](#functionality) -* [Usage](#usage) -* [Tests](#tests) -* [Hosting](#hosting) -* [Resources](#resources) +* [Usage](#usage---in-progress) +* [Tests](#tests---todo) +* [Hosting](#hosting---todo) +* [Resources](#resources---todo) +* [Configuration](#configuration) +* [`ping`](#on-accessing-ping) ## About @@ -152,40 +140,7 @@ or something like that. ## Resources - TODO - This section should be used to keep track of any 3rd party resources used to help aid in the creation of this project. -# PREVIOUS - TO MERGE - -## So far - -Working towards replacing https://github.com/hathitrust/common - -- [x] include bootstrap as a dependency -- [-] include Mulish - - [ ] as local dependency -- [x] collect color properties from Phire Design -- [-] collect typography properties - - [x] headings - - [ ] paragraphs -- [x] forms (in progress) - -## Using - -To run: - -``` -npm install -npm run start -``` - -Icons currently are included via a ` -``` - -## On `setupHTEnv` - -`lib/utils.js` starts pointing some `common` functionality to this new -environment. The *how* is subject to change as this project evolves. +## Configuration * `HT.prefs.set` and `HT.prefs.get` * configuring the various domains: @@ -194,7 +149,6 @@ environment. The *how* is subject to change as this project evolves. * `HT.www_domain` * `HT.cookies_domain` - ## On accessing `ping` The `navbar_login_example.html` has a NOP handler for invoking the `ping` utility: