Disclaimer in README.md about non-production readiness

Open Beginner friendly
#1,848 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
javascript
Domain
documentation

Research direction

Compare the existing disclaimer in index.html with README.md, starting at the README introduction or project description. Done means the README clearly includes the same prototype, security, and stability warning; no code changes are indicated.

Written by the indexing model from the issue text.

Description

Can we add a disclaimer in the README that NSS should not be used with production data? I've found that it's used in production and marketed as a "secure" place to store your data.

There's already following disclaimer in the index.html file:

This is a prototype implementation of a Solid server. It is a fully functional server, but there are no security or stability guarantees.

I think it serves the purpose of a prototype server well. But I think we should copy this disclaimer to the README to make clear expectations.

(And while it would be nice to get it production ready, I suppose there are not enough resources to make it secure in the near future)

Dominant language
JavaScript
Stars
1.8k
Forks
308
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nodeSolidServer/node-solid-server

All issues in nodeSolidServer/node-solid-server

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.