search

Shopify / koa-shopify-auth

DEPRECATED Middleware to authenticate a Koa application with Shopify
MIT License
80 stars 63 forks source link

Why isn't createShopifyAuth documented in README.md? #154

Closed RavenHursT closed 1 year ago

RavenHursT commented 2 years ago

Issue summary

Write a short description of the issue here ↓

This is more of a "question" than a "bug", but it seems GH Discussions aren't enabled on this repo, and the issue creation flow have an option to ask a question, so I'm doing it this way. I hope that's ok 😬

I see instructions for how to use shopifyAuth middleware. But most of the examples I've seen across the interwebs, plus the app that I've inherited, that I'm currently working on, are using createShopifyAuth: https://github.com/Shopify/koa-shopify-auth/blob/master/src/auth/index.ts#L33

I keep having to jump to that source code just to know how it behaves, what args I should send it, etc.

Expected behavior

What do you think should happen?

Would be nice to have this area properly documented, w/ some kind of explanation of the diff between shopifyAuth and createShopifyAuth

Actual behavior

What actually happens?

Have to read and interpret source code to use createShopifyAuth

technologytesting commented 2 years ago

Would be helpful as well since our app was built with createShopifyAuth too, and since updating to 5.0.3 have been facing issues

Draccano commented 2 years ago

Consolidating documentation could simplify development and make life easier. But in this case, may it doesn't matter how you call the default import function from koa-shopify-auth. Every name points to the default export from the library.

github-actions[bot] commented 1 year ago

Note that this repo is no longer maintained and this issue will not be reviewed. Prefer the official JavaScript API library. If you still want to use Koa, see simple-koa-shopify-auth for a potential community solution.