Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.5 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.5 KB
Raw

Unstoppable Authentication (UAuth)

Maybe Unstoppauthable...

Notes on versioning

Until the library reaches v1.0.0 each minor bump might be breaking. We will try to keep versions as stable as we can throughout development, but there will be no guarantees. However, each patch bump will not be breaking.

For now it is recommended to install versions of packages using a tilda ~ instead of a caret ^ (the default).

Yarn has the ability to install packages this way without having to mess with your package.json by installing packages using the --tilde flag:

yarn add --tilde @uauth/js
yarn add -T @uauth/js

Once we release the package for version v1.0.0, only major releases will be breaking and developers can install the package using the ^ again.

Core libraries

  • @uauth/js - SDK used to integrate into SPA applications.
  • @uauth/node - SDK used to integrate into Server-side applications.

Wallet middleware libraries

  • @uauth/web3-react - Middleware used to help integrate @uauth/js into web3-react applications.
  • @uauth/web3modal - Middleware used to help integrate @uauth/js into web3modal applications.
  • @uauth/bnc-onboard - Middleware used to help integrate @uauth/js into bnc-onboard applications.

Utility libraries

You should not need to use or expect these libraries to remain stable.

  • @uauth/common - Common utilities used by various uauth libraries
  • @uauth/dom-ui - A simple DOM-based UI used by @uauth/js to facilitate sign in.
  • @uauth/abstract-ui - The UI interface used by @uauth/js to facilitate sign in.

Related libraries

Examples

  • spa - Basic integration using the @uauth/js library.
  • web3-react - Integration using the @uauth/js & @uauth/web3-react library.
  • web3modal - Integration using the @uauth/js & @uauth/web3modal library.
  • bnc-onboard - Integration using the @uauth/js & @uauth/bnc-onboard library.
  • sveltekit - Integration using the sveltekit framework and @uauth/js.
  • server - Integration using the @uauth/node library.