Skip to content

Commit 7b35c74

Browse files
README.md
1 parent ef57b58 commit 7b35c74

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,15 @@ require 'libpath'
4242

4343
## Components
4444

45-
T.B.C.
45+
The main components of **libpath.Ruby** are:
46+
47+
* **`LibPath::Form`** — path-form classification and probes (`classify_path`, `path_is_absolute?`, `path_is_homed?`, `path_is_rooted?`, `name_is_malformed?`);
48+
* **`LibPath::Path::ParsedPath`** — structured parse of a path string into directory / file / search-relative attributes (platform-selected Unix or Windows implementation);
49+
* **`LibPath::Util`** — path combination and rewriting (`combine_paths`, `derive_relative_path`, `make_compare_path`, `make_path_absolute`, `make_path_canonical`);
50+
* **`LibPath::Constants`** — platform path-name / path / shell character constants;
51+
* **`LibPath::Exceptions`** — path-related exceptions such as `MalformedNameException`;
52+
53+
Platform-specific details live under `::Unix` / `::Windows` submodules; the top-level `Form`, `Path`, and `Util` modules select the ambient OS automatically.
4654

4755

4856
## Examples

0 commit comments

Comments
 (0)