Skip to content

Commit 590c2a6

Browse files
committed
Update README with installation instructions
1 parent f84b831 commit 590c2a6

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,34 @@
33
[![CI](https://github.com/yetanalytics/re-oidc/actions/workflows/ci.yml/badge.svg)](https://github.com/yetanalytics/re-oidc/actions/workflows/ci.yml)
44
[![Clojars Version](https://img.shields.io/clojars/v/com.yetanalytics/re-oidc)](https://clojars.org/com.yetanalytics/re-oidc)
55

6-
A wrapper for [oidc-client-js](https://github.com/IdentityModel/oidc-client-js) providing [OIDC](https://openid.net/specs/openid-connect-core-1_0.html) support for re-frame + reagent applications in cljs. Inspired by [re-frame-oidc](https://github.com/tafarij/re-frame-oidc).
6+
A wrapper for [oidc-client-ts](https://github.com/authts/oidc-client-ts) providing [OIDC](https://openid.net/specs/openid-connect-core-1_0.html) support for re-frame + reagent applications in cljs. Inspired by [re-frame-oidc](https://github.com/tafarij/re-frame-oidc).
77

88
## Overview
99

1010
Re-frame fx, event handlers and subscriptions are provided to allow interactive sign-in from an SPA without the need for a server backend.
1111

12+
## Installation
13+
14+
Add the following dependency to your deps.edn file:
15+
16+
```clojure
17+
com.yetanalytics/re-oidc {:mvn/version "0.1.0"
18+
:exclusions [io.github.cljsjs/oidc-client-ts
19+
reagent/reagent
20+
re-frame/re-frame]}
21+
```
22+
23+
For production, you will need to add the following `cljsjs/oidc_client_ts.cljs` ClojureScript source:
24+
25+
```clojure
26+
(ns cljsjs.oidc-client-ts
27+
(:require [oidc-client-ts :as oidc]))
28+
29+
(def UserManager oidc/UserManager)
30+
(def Log oidc/Log)
31+
(def WebStorageStateStore oidc/WebStorageStateStore)
32+
```
33+
1234
## Configuration
1335

1436
Re-oidc requires a map of configuration options:

0 commit comments

Comments
 (0)