Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lionralfs committed Feb 16, 2022
1 parent 3dc5fe8 commit 56d89e1
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
> [#2](https://github.com/lionralfs/disconnect/pull/2) is the result of me turning this entire library into ES Modules, adding support for all endpoints, adding more tests, docs and type info via JSDoc (+ a generated types.d.ts).
[#2](https://github.com/lionralfs/disconnect/pull/2) is a giant refactor of the [origial library](https://github.com/bartve/disconnect) by doing the following:

- using ES Modules
- using TypeScript (and generating type declarations) for typed parameters and API results
- removing callbacks in favor of Promises
- using Esbuild to provide a bundle that is consumable by either:
- node via ESM
- node via CommonJS
- browsers (where node-fetch is replaced with native window.fetch)
- adding support for all remaining Discogs endpoints
- adding more tests
- adding docs and type info via JSDoc (for non-TypeScript users)

## About

`disconnect` is a [Node.js](http://www.nodejs.org) client library that connects with the [Discogs.com API v2.0](http://www.discogs.com/developers/).

[![Dependency Status](https://david-dm.org/bartve/disconnect.png)](https://david-dm.org/bartve/disconnect)

## Features

* Covers all API endpoints
Expand All @@ -15,10 +24,6 @@
* Easy access to protected endpoints with `Discogs Auth`
* Includes OAuth 1.0a tools. Just plug in your consumer key and secret and do the OAuth dance
* API functions grouped in their own namespace for easy access and isolation

## Todo

* Add more tests

## Installation

Expand Down

0 comments on commit 56d89e1

Please sign in to comment.