Christian Bundy 51635ce6f6 Remove references to npm registry publish

Problem: The npm registry is great for proprietary modules who need to
ship binaries but not really useful for free and open source software.
It creates a divide between users and our Git repo, and introduces a
for-profit company as an intermediary to distribute Oasis.

Solution: Remove the npm registry as a distribution platform and just
use our Git repository instead. This removes npm registry references
from the readme, instead prioritizing the GitHub repository, and leaves
room for others to mirror the Git repository (for allows us to move to
less-Microsofty Git hosting).

2020-02-17 16:40:53 -08:00

3.0 KiB

Raw Blame History

Oasis

Oasis is a free, open-source, peer-to-peer social application that helps you follow friends and discover new ones on Secure Scuttlebutt (SSB).

🦀 Powered by SSB.
You're the center of your own distributed network. Online or offline, SSB works anywhere that you are. Follow the people you want to see and never worry about spam again. Migrate your data to another SSB app any time you want.

🌐 Bring your own browser.
Use your favorite web browser to read and write messages to the people you care about. Oasis runs over HTTP, so you don't need to worry about adding another Electron app to your computer.

🏰 Just HTML and CSS.
No browser JavaScript! Oasis has strict security rules that prevent any JavaScript from running in your browser, which helps us make Oasis accessible and easy to improve.

Usage

Start Oasis from a command-line interface with the oasis command.

$ oasis --help
Usage: oasis [options]

Options:
  --version   Show version number                                      [boolean]
  -h, --help  Show help                                                [boolean]
  --open      Automatically open app in web browser. Use --no-open to disable.
                                                       [boolean] [default: true]
  --offline   Don't try to connect to scuttlebutt peers or pubs. This can be
              changed on the 'settings' page while Oasis is running.
                                                      [boolean] [default: false]
  --host      Hostname for web app to listen on  [string] [default: "localhost"]
  --port      Port for web app to listen on             [number] [default: 3000]
  --debug     Use verbose output for debugging        [boolean] [default: false]

Installation

Most people should install stable releases with npm and Node.js current or active LTS release.

npm --global install 'fraction/oasis#semver:*'

For faster updates and less stability, install from GitHub and upgrade often.

npm --global install fraction/oasis

Want more? Check out install.md.

Resources

License

AGPL-3.0

3.0 KiB Raw Blame History