diff --git a/README.md b/README.md index bc7f6cf..f57b778 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,4 @@ -# Table of Contents - -1. [Cl-Sbt](#org6af45e7) - 1. [Usage](#org4b1729c) - 1. [Defining a Card](#org8a876fa) - 2. [Defining a Dropdown](#orgcb10ca2) - 2. [Installation](#org0da4cf2) - 3. [Author](#org919d853) - 4. [Copyright](#orgc51162e) - - - # Cl-Sbt @@ -20,14 +8,25 @@ badges, buttons, cards, dropdowns, headers, list groups, navbars, nav-tabs, pagination, and tables. This library is dependent on the Spinneret library for HTML generation. +The following components are available and are packages: + +- accordion +- alert +- badge +- button +- card +- dropdown +- list group +- navbar +- nav / tab +- pagination +- table +- spinner - ## Usage - - ### Defining a Card The following code demonstrates how to define a card using the card macro. @@ -72,8 +71,6 @@ The following code demonstrates how to define a card using the card-with-img mac - - ### Defining a Dropdown The following code demonstrates how to define a dropdown using the dropdown @@ -97,8 +94,6 @@ macro. - - ## Installation git clone https://git.sr.ht/~marcuskammer/cl-sbt ~/quicklisp/local-projects/cl-sbt/ @@ -106,15 +101,11 @@ macro. (ql:quickload :cl-sbt) - - ## Author - Marcus Kammer (marcus.kammer@mailbox.org) - - ## Copyright Copyright (c) 2023 Marcus Kammer (marcus.kammer@mailbox.org) diff --git a/README.org b/README.org index 817ea14..01f8cb3 100644 --- a/README.org +++ b/README.org @@ -1,3 +1,7 @@ +#+author: Marcus Kammer +#+email: marcus.kammer@mailbox.org +#+options: toc:nil + * Cl-Sbt A Common Lisp library for generating Bootstrap-based HTML markup. It provides @@ -6,6 +10,21 @@ badges, buttons, cards, dropdowns, headers, list groups, navbars, nav-tabs, pagination, and tables. This library is dependent on the Spinneret library for HTML generation. +The following components are available and are packages: + +- accordion +- alert +- badge +- button +- card +- dropdown +- list group +- navbar +- nav / tab +- pagination +- table +- spinner + ** Usage *** Defining a Card