Skip to content

Commit 612011a

Browse files
authored
Update README.md
1 parent 02a4bf2 commit 612011a

File tree

2 files changed

+3
-15
lines changed

2 files changed

+3
-15
lines changed

README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1 @@
1-
# Halberd
2-
A TOTP (Time-Based One-Time Password) Two-Factor Authentication Module for [codeigniter4/shield](https://github.com/codeigniter4/shield)
3-
## Installation
4-
Project should have a stability level of dev
5-
```
6-
composer config minimum-stability dev
7-
composer config prefer-stable true
8-
composer require grimpirate/halberd:dev-develop
9-
```
10-
## Remarks
11-
1. The dependency [pragmarx/google2fa](https://github.com/antonioribeiro/google2fa?tab=readme-ov-file#server-time) requires that your server time be accurately synchronized (via NTP or some other means).
12-
2. CodeIgniter's [appTimezone](https://github.com/codeigniter4/CodeIgniter4/blob/655bd1de0c460b0e1353d2ead8ecff956ac08ccc/app/Config/App.php#L136) will not affect OTP generation.
13-
3. Requires php [xmlwriter](https://www.php.net/manual/en/book.xmlwriter.php) extension.
1+
Documentation: [https://grimpirate.github.io/halberd](https://grimpirate.github.io/halberd)

zensical.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,5 +319,5 @@ logo = "lucide/flame"
319319
icon = "fontawesome/brands/github"
320320
link = "https://github.com/grimpirate"
321321

322-
#[project.extra]
323-
#generator = false
322+
[project.extra]
323+
generator = false

0 commit comments

Comments
 (0)