Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation warning #173

Merged
merged 1 commit into from
Jan 3, 2021
Merged

Add deprecation warning #173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# A library for reading and writing to Solid pods
# A library for reading and writing to legacy Solid pods

[![Build Status](https://travis-ci.org/solid/solid-auth-client.svg?branch=master)](https://travis-ci.org/solid/solid-auth-client)
[![Coverage Status](https://coveralls.io/repos/github/solid/solid-auth-client/badge.svg?branch=master)](https://coveralls.io/github/solid/solid-auth-client?branch=master)
[![NPM Package](https://img.shields.io/npm/v/solid-auth-client.svg)](https://www.npmjs.com/package/solid-auth-client)

The [Solid](https://solid.mit.edu/) project
The [Solid](https://solidproject.org/) project
allows people to use apps on the Web
while storing their data in their own data pod.

`solid-auth-client` is a browser library that allows
your apps to securely log in to Solid data pods
and read and write data from them.
`solid-auth-client` is a legacy browser library
that allows your apps to log in and read/write data using
a [Node Solid Server](https://github.com/solid/node-solid-server/).

**⚠️ New projects should use [solid-client-authn](https://github.com/inrupt/solid-client-authn-js) instead,
Copy link
Member

Choose a reason for hiding this comment

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

or solid-auth-fetcher

which leverages the secure DPoP authentication mechanism
from the current [Solid specification](https://solid.github.io/authentication-panel/solid-oidc/),
as implemented by
the [Community Solid Server](https://github.com/solid/community-server/)
and
the [Enterprise Solid Server](https://inrupt.com/products/enterprise-solid-server/).**

## Usage
In the browser, the library is accessible through `solid.auth`:
Expand Down