Skip to content

Commit

Permalink
Document docs at deno.land no longer working
Browse files Browse the repository at this point in the history
  • Loading branch information
bjuppa authored Jan 6, 2025
1 parent 5e27e08 commit 64f29da
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,23 @@ timezones on the surface_.

This readme aims to explain how ComPlainDate works, but doesn't contain full
explanations of all available operations. The detailed documentation and
categorized lists of available functions are available at the _deno.land_
website:
categorized lists of available functions were once available at the _deno.land_
website, but that is no longer the case.

Visit
[the ComPlainDate API documentation](https://deno.land/x/complaindate/mod.ts) to
explore which specific utilities you can use to solve your problem.
We hope to regain documentation once this package is published at JSR instead,
see [Issue #88](https://github.com/bjuppa/com-plain-date/issues/88) for progress.

Please note that all the links to the _deno.land_ docs from this readme are currently not working.
The simplest workaround is to browse the source files on GitHub instead,
and read the docblocks straight from the source.
Not ideal, we know, sorry.

## Installation

ComPlainDate is distributed as an **npm** package as well as a **Deno** module:

- [npmjs.com/package/complaindate](https://www.npmjs.com/package/complaindate)
- [deno.land/x/complaindate](https://deno.land/x/complaindate/mod.ts)
- [deno.land/x/complaindate](https://deno.land/x/complaindate)

## Table of contents

Expand Down

0 comments on commit 64f29da

Please sign in to comment.