Welcome to the TOP SECRET real-time package!
-
Install Atom 1.21 or newer
-
In the terminal, install the package via apm:
apm install atom/real-time
- Install Atom 1.21 or newer
- Launch Atom
- Open Settings View using Cmd+, on macOS or Ctrl+, on other platforms
- Click the Install tab on the left side
- Enter
https://github.com/atom/real-time
in the search box and press Enter - Click the "Install" button that appears
Once you've installed the package, you're ready to start collaborating in real-time.
- To share your workspace, open the command palette and run the Real Time: Share Portal command. Then, use Slack to send the portal ID to the GitHubbers that you want to collaborate with.
- To join a portal, open the command palette, run the Real Time: Join Portal command, and enter the portal ID.
It's super early days for the real-time package, so there are a few things you'll want to keep in mind:
- Portals use security-by-obscurity for now. Anyone with your portal ID can join your portal. (We'll address this in Milestone 2.)
- If you're wondering what's coming next, check out the roadmap.
- If you notice any issues or have any feedback, please open an issue or ping us (@as-cii, @jasonrudolph, @nathansobo) in the #atom-real-time channel.
Prerequisites: For now, you must be a member of the @atom/hubbers team in npm. If you aren't, please drop a note in #atom-real-time and we'll add you.
git clone https://github.com/atom/real-time
cd real-time
apm install
apm link