Skip to content

Conversation

ajmeese7
Copy link
Contributor

🧰 Changes

Adds documentation for how to use the library with ESM syntax, which is something I struggled with for a bit.

🧬 QA & Testing

I've used this syntax on my end and it works identically to the require syntax.

docs/usage.md Outdated

```js
import api from 'api';
const petstore = api('@petstore/v1.0#tl1e4kl1cl8eg8');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is specific to the dynamic implementation of the library can you move this down into the Dynamically section below?

@erunion erunion added area:core Issues related to `core`, which is the package that powers the SDKs at runtime documentation Improvements or additions to documentation labels Jan 18, 2023
Copy link
Member

@erunion erunion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

@erunion erunion merged commit 6fadba7 into readmeio:main Jan 19, 2023
@ajmeese7 ajmeese7 deleted the docs/esm-syntax branch January 19, 2023 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:core Issues related to `core`, which is the package that powers the SDKs at runtime documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants