diff --git a/README.md b/README.md index 68e79a2..19e0c13 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![npm](https://img.shields.io/npm/v/ng-postcode-js.svg?label=npm%20ng-postcode-js)](https://www.npmjs.com/package/ng-postcode-js) [![npm MCP server](https://img.shields.io/npm/v/ng-postcode-mcp.svg?label=npm%20ng-postcode-mcp)](https://www.npmjs.com/package/ng-postcode-mcp) -Developer tools for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), the building-level postcode NIPOST launched in October 2026: libraries for Rust, Python, JavaScript, and Java, MCP servers for AI assistants on PyPI and npm, and a resolver that turns described addresses into postcodes. +Developer tools for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), the building-level postcode NIPOST launched in October 2026: libraries for Rust and Python (`ng-postcode`), JavaScript (`ng-postcode-js` on npm), and Java (`ng-postcode-api`), MCP servers for AI assistants on PyPI and npm, and a resolver that turns described addresses into postcodes. A postcode has 11 characters in five segments, written `EK-01-A03-FK-01`: state, LGA, district, area and building unit. diff --git a/docs/llms-full.txt b/docs/llms-full.txt index 81e2671..83ebbb9 100644 --- a/docs/llms-full.txt +++ b/docs/llms-full.txt @@ -62,7 +62,7 @@ Since 1 October 2026 a Nigerian building's postcode is this 11-character code. A [![npm](https://img.shields.io/npm/v/ng-postcode-js.svg?label=npm%20ng-postcode-js)](https://www.npmjs.com/package/ng-postcode-js) [![npm MCP server](https://img.shields.io/npm/v/ng-postcode-mcp.svg?label=npm%20ng-postcode-mcp)](https://www.npmjs.com/package/ng-postcode-mcp) -Developer tools for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), the building-level postcode NIPOST launched in October 2026: libraries for Rust, Python, JavaScript, and Java, MCP servers for AI assistants on PyPI and npm, and a resolver that turns described addresses into postcodes. +Developer tools for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), the building-level postcode NIPOST launched in October 2026: libraries for Rust and Python (`ng-postcode`), JavaScript (`ng-postcode-js` on npm), and Java (`ng-postcode-api`), MCP servers for AI assistants on PyPI and npm, and a resolver that turns described addresses into postcodes. A postcode has 11 characters in five segments, written `EK-01-A03-FK-01`: state, LGA, district, area and building unit. @@ -760,6 +760,8 @@ MCP server for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), Built on the [`ng-postcode`](https://pypi.org/project/ng-postcode/) and [`ng-address-resolver`](https://pypi.org/project/ng-address-resolver/) libraries. A Node edition with the same tools, apart from `resolve_address`, is on npm as [`ng-postcode-mcp`](https://www.npmjs.com/package/ng-postcode-mcp) and runs with `npx`. +To validate postcodes in your own code, use the libraries: [`ng-postcode`](https://pypi.org/project/ng-postcode/) for Python, [`ng-postcode-js`](https://www.npmjs.com/package/ng-postcode-js) for JavaScript, [`ng-postcode`](https://crates.io/crates/ng-postcode) for Rust, and [`ng-postcode-api`](https://central.sonatype.com/artifact/io.github.adeniyikayodee/ng-postcode-api) for Java. + ## Tools @@ -879,6 +881,8 @@ MCP server for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), This is the Node edition of the [ng-postcode](https://github.com/Adeniyikayodee/ng-postcode) server. It registers its tools from the same contract as the Python edition, so names, descriptions and schemas are identical. The Python edition also has `resolve_address` and an HTTP transport. +To validate postcodes in your own code, use the library, [`ng-postcode-js`](https://www.npmjs.com/package/ng-postcode-js). + ## Install diff --git a/js/packages/ng-postcode-mcp/README.md b/js/packages/ng-postcode-mcp/README.md index 13a81f9..547bc83 100644 --- a/js/packages/ng-postcode-mcp/README.md +++ b/js/packages/ng-postcode-mcp/README.md @@ -4,6 +4,8 @@ MCP server for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), This is the Node edition of the [ng-postcode](https://github.com/Adeniyikayodee/ng-postcode) server. It registers its tools from the same contract as the Python edition, so names, descriptions and schemas are identical. The Python edition also has `resolve_address` and an HTTP transport. +To validate postcodes in your own code, use the library, [`ng-postcode-js`](https://www.npmjs.com/package/ng-postcode-js). + ## Install diff --git a/mcp/README.md b/mcp/README.md index fcae312..68d7915 100644 --- a/mcp/README.md +++ b/mcp/README.md @@ -4,6 +4,8 @@ MCP server for Nigeria's National Digital Alphanumeric Postcode System (NDAPS), Built on the [`ng-postcode`](https://pypi.org/project/ng-postcode/) and [`ng-address-resolver`](https://pypi.org/project/ng-address-resolver/) libraries. A Node edition with the same tools, apart from `resolve_address`, is on npm as [`ng-postcode-mcp`](https://www.npmjs.com/package/ng-postcode-mcp) and runs with `npx`. +To validate postcodes in your own code, use the libraries: [`ng-postcode`](https://pypi.org/project/ng-postcode/) for Python, [`ng-postcode-js`](https://www.npmjs.com/package/ng-postcode-js) for JavaScript, [`ng-postcode`](https://crates.io/crates/ng-postcode) for Rust, and [`ng-postcode-api`](https://central.sonatype.com/artifact/io.github.adeniyikayodee/ng-postcode-api) for Java. + ## Tools