Skip to content

Commit ca2cf30

Browse files
docs(repo): drop the unofficial disclaimer
Owner's call. Descriptions now say what the library does for the postcode rather than who made it.
1 parent bd2a385 commit ca2cf30

6 files changed

Lines changed: 5 additions & 9 deletions

File tree

‎Cargo.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[package]
22
name = "ng-postcode"
3-
version = "0.1.1"
3+
version = "0.1.2"
44
edition = "2021"
5-
description = "Nigeria's NIPOST digital postcode (NDAPS): parse, validate and format codes offline, plus a client for the postcode.gov.ng API. Unofficial."
5+
description = "Parse, validate and format Nigeria's NIPOST digital postcode (NDAPS) offline, plus a client for the postcode.gov.ng API."
66
license = "MIT"
77
repository = "https://github.com/Adeniyikayodee/ng-postcode"
88
documentation = "https://docs.rs/ng-postcode"

‎README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55

66
Rust library for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), the building-level postcode NIPOST launched in October 2026. Parse, validate and format postcodes offline, and call the [postcode.gov.ng](https://docs.postcode.gov.ng) API for lookup, autocomplete and reverse geocoding.
77

8-
**Unofficial.** Not made or endorsed by NIPOST.
9-
108
A Python package with the same behaviour lives in [`python/`](python). Both pass the shared cases in [`spec/vectors.json`](spec/vectors.json).
119

1210
## Format

‎python/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Python library for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), the building-level postcode NIPOST launched in October 2026. Parse, validate and format postcodes offline, and call the [postcode.gov.ng](https://docs.postcode.gov.ng) API for lookup, autocomplete and reverse geocoding.
44

5-
**Unofficial.** Not made or endorsed by NIPOST. Also available for Rust: [`ng-postcode` on crates.io](https://crates.io/crates/ng-postcode).
5+
Also available for Rust: [`ng-postcode` on crates.io](https://crates.io/crates/ng-postcode).
66

77
```sh
88
pip install ng-postcode # offline core, no dependencies

‎python/pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
55
[project]
66
name = "ng-postcode"
77
version = "0.1.0"
8-
description = "Nigeria's NIPOST digital postcode (NDAPS): parse, validate and format codes offline, plus a client for the postcode.gov.ng API. Unofficial."
8+
description = "Parse, validate and format Nigeria's NIPOST digital postcode (NDAPS) offline, plus a client for the postcode.gov.ng API."
99
readme = "README.md"
1010
requires-python = ">=3.10"
1111
license = "MIT"

‎python/src/ng_postcode/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Nigeria's National Digital Alphanumeric Postcode (NDAPS), the building-level
2-
postcode issued by NIPOST. Unofficial: not made or endorsed by NIPOST.
2+
postcode issued by NIPOST.
33
44
Expected failures come back as values, never exceptions:
55

‎src/lib.rs‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
//! Nigeria's National Digital Alphanumeric Postcode (NDAPS), the
22
//! building-level postcode issued by NIPOST.
33
//!
4-
//! Unofficial: not made or endorsed by NIPOST.
5-
//!
64
//! The crate has a pure core and an optional shell:
75
//!
86
//! - [`Postcode`] parses, validates and formats codes offline.

0 commit comments

Comments
 (0)