From f5f255a4517e8facf9c097fde912c60a3dafc08c Mon Sep 17 00:00:00 2001
From: Steve Bauman
Date: Thu, 8 Oct 2026 13:20:52 -0400
Subject: [PATCH] Align README presentation with DirectoryTree packages
---
readme.md | 81 ++++++++++++++++++++++++++-----------------------------
1 file changed, 38 insertions(+), 43 deletions(-)
diff --git a/readme.md b/readme.md
index 2a2d5c00..8d976738 100644
--- a/readme.md
+++ b/readme.md
@@ -1,91 +1,86 @@
-
+
-
-
-
-
-
-
+An Active Record ORM for working with LDAP directories.
- Working with LDAP doesn't need to be hard.
+
+
+
+
- LdapRecord is a fully-featured Active Record
- ORM that makes working with LDAP directories a breeze 🍃
-
-
-
+
---
-⏲ **Up and Running Fast**
+## Installation
+
+Install the package via Composer:
+
+```bash
+composer require directorytree/ldaprecord
+```
+
+See the [installation guide](https://ldaprecord.com/docs/core/v4/installation/) for requirements and setup, then follow the [quickstart](https://ldaprecord.com/docs/core/v4/quickstart/) to connect to your directory.
+
+## Features
+
+### Up and Running Fast
Connect to your LDAP servers and start running queries in a matter of minutes.
-💡 **Fluent Filter Builder**
+### Fluent Filter Builder
Find the LDAP objects you're looking for with a fluent LDAP filter builder.
-💼 **Multi-Domain Ready**
+### Multi-Domain Ready
Built-in connection management allows you to access multiple domains without breaking a sweat.
-🔥 **Supercharged Active Record**
+### Supercharged Active Record
Create and modify LDAP objects with minimal code.
----
-
-
-Active Directory Features
-
+## Active Directory Features
-🚪 **Enable / Disable Accounts**
+### Enable / Disable Accounts
Detect and assign User Account Control values on accounts with the fluent [Account Control builder](https://ldaprecord.com/docs/core/v4/active-directory/users/#uac).
-🔑 **Reset / Change Passwords**
+### Reset / Change Passwords
Built-in support for [changing](https://ldaprecord.com/docs/core/v4/active-directory/users/#changing-passwords) and [resetting](https://ldaprecord.com/docs/core/v4/active-directory/users/#resetting-passwords) passwords on Active Directory accounts.
-🗑 **Restore Deleted Objects**
+### Restore Deleted Objects
Seamlessly access your Active Directory recycle bin and [restore deleted objects](https://ldaprecord.com/docs/core/v4/models/#restoring-deleted-models).
----
-
-LdapRecord is Supportware™
-
-If you require support using LdapRecord, a sponsorship is required :pray:
+## LdapRecord is Supportware™
-Thank you for your understanding :heart:
+If you require support using LdapRecord, a [sponsorship](https://github.com/sponsors/stevebauman) is required :pray:
----
+Thank you for your understanding :heart:
-Security Vulnerabilities
+## Security Vulnerabilities
-If you discover a security vulnerability within LdapRecord, please send an e-mail to Steve Bauman via steven_bauman@outlook.com.
+If you discover a security vulnerability within LdapRecord, please send an e-mail to Steve Bauman via [steven_bauman@outlook.com](mailto:steven_bauman@outlook.com).
-All security vulnerabilities will be promptly addressed.
-
----
+All security vulnerabilities will be promptly addressed.
-Credits
+## Credits
-This package is directly inspired from Laravel's Eloquent, and most features are direct ports to an LDAP equivalent.
+This package is directly inspired from [Laravel's Eloquent](https://laravel.com/docs/eloquent), and most features are direct ports to an LDAP equivalent.
-I am forever grateful for the work Taylor Otwell has produced.
+I am forever grateful for the work [Taylor Otwell](https://github.com/taylorotwell) has produced.
-If you can, support his work by purchasing a sponsorship, or one of his many Laravel based services.
+If you can, support his work by purchasing a [sponsorship](https://github.com/sponsors/taylorotwell), or one of his many Laravel based services.