From 9dbdecc130ae8a0b466ecf5131e714663de3ad1e Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 17:38:51 -0700 Subject: [PATCH 01/15] update readme and remove RTD pages --- README.md | 201 ++++++++++++++++-- docs/meta/changelog.md => changelog.md | 0 .../meta/collaborators.md => collaborators.md | 0 docs/api.md | 51 ----- docs/assets/extra.css | 19 -- docs/index.md | 1 - docs/usage.md | 65 ------ mkdocs.yml | 10 - 8 files changed, 178 insertions(+), 169 deletions(-) rename docs/meta/changelog.md => changelog.md (100%) rename docs/meta/collaborators.md => collaborators.md (100%) delete mode 100644 docs/api.md delete mode 100644 docs/assets/extra.css delete mode 120000 docs/index.md delete mode 100644 docs/usage.md delete mode 100644 mkdocs.yml diff --git a/README.md b/README.md index 46034261..f83bad2d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,15 @@ -# dat +# Dat Dat is a decentralized data tool for distributing data small and large. [![#dat IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23dat%20on%20freenode-blue.svg)](http://webchat.freenode.net/?channels=dat) [![datproject/discussions](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/datproject/discussions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![docs](https://readthedocs.org/projects/dat-cli/badge/?version=latest)](http://docs.dat-data.com) - +[![docs](https://img.shields.io/badge/Dat%20Project-Docs-green.svg)](http://docs.dat-data.com) Windows | Mac/Linux -------------- | ------------ [![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) -## About Dat - -Documentation for the Dat project is available at [docs.dat-data.com](http://docs.dat-data.com). - ### Key features: * **Live sync** folders by sharing files as they are added to the folder. @@ -22,33 +17,87 @@ Documentation for the Dat project is available at [docs.dat-data.com](http://doc * **Intelligently sync** by deduplicating data between versions. * **Verify data integrity** using strong cryptographic hashes. * **Work everywhere**, including in the [browser](https://github.com/datproject/dat.land) and on the [desktop](https://github.com/juliangruber/dat-desktop). + +## Table of Contents -Dat embraces the Unix philosophy: a modular design with composable parts. All of the pieces can be replaced with alternative implementations as long as they implement the abstract API. +
+ Table of Contents +
  • Getting Started
    • +
  • Using Dat
    • +
  • Troubleshooting
    • +
  • Dat Ecosystem
    • +
  • For Developers
    • +
    + +--- -## CLI Development Status +## Getting Started + +The Dat command line interface can be used to share, download, and sync files across many computers. + +### CLI Development Status This is the Dat CLI 1.0 release candidate (RC2). We are actively seeking feedback & developing this release candidate. Follow [this issue](https://github.com/datproject/projects/issues/5) for the Dat CLI road map discussion and see [known RC2 issues](https://github.com/maxogden/dat/issues/486). **Please note** that previous versions of Dat (alpha, beta) are incompatible with the 1.0 release candidate. -## Getting started - ### Install -To install the 1.0 release candidate from npm: +To use Dat you will need to have [node and npm installed](https://docs.npmjs.com/getting-started/installing-node). Once you have npm, you can install Dat with npm: ``` -npm install dat -g +npm install -g dat +``` + +The `-g` option installs Dat globally allowing you to run it as a command. + +Running `dat` in the console, with no arguments, should show you the usage guide: + +```bash +dat + + share directory and create a dat-link + + --snapshot create a snapshot of directory + --port, -p set a specific inbound tcp port + +dat + + download a dat-link into directory + + --exit exit process after download finishes + --port, -p set a specific inbound tcp port + +general options + + --version, -v get installed dat version + --doctor run dat doctor + --quiet, -q output only dat-link, no progress information + --debug show debugging output ``` -If you receive an `EACCES` error read [this guide](https://docs.npmjs.com/getting-started/fixing-npm-permissions). +If the `dat` command does not work, there may have been issues in your installation, see the [installation troubleshooting](#troubleshooting). + +### Demo -### Using Dat +We have Dat installed, now let's use it! In this quick demo we will download our documentation files using Dat. -There are two main commands in dat: +You tell Dat what files to download by giving it a Dat link. Dat links are 64 character strings, for example 395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2. -1. Share data: `dat ` -2. Download data: `dat ` +Along with the link, you need to tell Dat what directory to download the files to. All together, you can download files by typing `dat `. + +For this example, we are going to download the Dat documentation files. In your console, run `dat 395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2 dat_docs` and you should see the output below. Once the download is finished, the files will be available on your computer! + +**put gif here** + +## Using Dat + +The Dat command line interface makes it simple to share files or data across many computers. The source can be files on your computer or files shared via Dat on another computer. + +There are two commands in Dat: + +1. Share data: `dat ` will share a directory on your computer. +2. Download data: `dat ` will download files from the Dat link to a directory on your computer. ### Sharing Files @@ -66,11 +115,29 @@ The Share Link is secret and only those you share it with will be able to get th Connected to 1 peers. Uploading 288.2 B/s. Watching for updates... ``` -You are now publishing that data from your computer. It will be publicly accessible as long as your terminal is open. The hash is a **secret hash**, your data is visible to anyone you send the hash to. As you add more files to the folder, dat will update and share the new files. +You are now publishing that data from your computer. It will be publicly accessible as long as your terminal is open and the process is still running. The hash is a **secret hash**, your data is visible to anyone you send the hash to. As you add more files to the folder, Dat will update and share the new files. + +#### Updating Shared Files + +Dat makes it easy to share a folder and send files as they are added to the folder. By default, when you share using `dat my_data/` you will be in live sync mode. Anyone connected to you will receive new files. + +#### Creating a snapshot + +A snapshot reads the files and creates a unique link that will always be the same for that set of files (if they remain unedited). To create a snapshot use the snapshot option: `dat my_data/ --snapshot`. Snapshots are automatically created for you in live mode. + +#### Sharing Options + +`dat --snapshot` + +Share a snapshot of the current files. + +`dat --port=1234` + +Set your inbound TCP port. This is useful for debugging or on restrictive networks. ### Downloading Files -Your colleague can get data like this: +Download files from a Dat link by typing: `dat `: ``` $ dat d6e1875598fae25165eff440ffd01513197ad0db9dbb9898f2a141288b9322c6 download_dir @@ -84,9 +151,89 @@ The Share Link is secret and only those you share it with will be able to get th Connected to 1 peers. Downloading 1.44 kB/s. Watching for updates... ``` -It will start downloading the data into the `download_dir` folder. Anyone who gets access to the unique dat-link will be able to download and re-host a copy of the data. It's distributed mad science! +Dat will start downloading the data into the `download_dir` folder. Once the download is finished (a message will print and the bar will turn green), you can safely exit the process with `Ctrl-C` (`Cmd-C` on Mac). + +While downloading, you may be connected to more than 1 peer. Anyone who has the Dat link will be able to download and re-host a copy of the data. So you may be downloading from (and sharing to) other people that are also doing this tutorial! You only need one block of data to start helping as a host. It's distributed mad science! + +#### Updating the Downloaded Files + +What happens if the files get updated? Dat auto-syncs new files. So if you still have the process open it will download the new files. If you exited the process, you can run the same command you ran before (with the same link and directory) and the files will update! + +#### Download Options + +`dat --exit` -For more information, see the [dat project documentation](http://docs.dat-data.com). +After files are done downloading, exit the process. If you are connected to a live Dat you will not get new files unless you run the command again. + +`dat --port=1234` + +Set your inbound TCP port. This is useful for debugging or on restrictive networks. + +### Additional Usage Options + +* `dat --version`: get the version of Dat you are running. +* `dat --doctor`: visit the doctor to help identify connectivity issues. +* `dat --quiet`: output only dat-link, no progress information +* `dat --debug`: show debugging output + +#### Live Sync & Snapshots + +Dat makes it easy to share a folder and send files as they are changed or added to the folder. By default, when you share using Dat you will be in *live sync* mode. Anyone connected to you will receive file changes as you make them. + +A snapshot reads the files and creates a specific link that will never change (as long as the files don't change). To create a snapshot use the snapshot option: `dat my_data/ --snapshot`. Snapshots are automatically created for you in live mode. + +When downloading a Dat, you do not have to worry about live mode. It will automatically start in the right mode based on the link. + +#### Local Storage + +When you run a command, Dat creates a hidden folder, `.dat`, in the directory specified. Similar to git, this folder stores information about your Dat. File metadata and the Dat link are stored to make it easy to continue sharing or downloading the same directory. + +## Troubleshooting + +We've provided some troubleshooting tips based on issues users have seen. Please [open an issue](https://github.com/maxogden/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions) if you need help troubleshooting and it is not covered here. + +If you have trouble sharing/downloading in a directory with a `.dat` folder, try deleting it and running the command again. + +#### Check Your Dat Version + +Knowing the version is really helpful if you run into any bugs, and will help us troubleshoot your issue. + +Check your Dat version: + +``` +dat -v +``` + +You should see the Dat semantic version printed, e.g. 11.1.2. + +### Install Issues + +* If you receive an `EACCES` error, read [this guide](https://docs.npmjs.com/getting-started/fixing-npm-permissions) on fixing npm permissions. +* Have other installation issues? Let us know, you can [open an issue](https://github.com/maxogden/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions). + +### Networking Issues + +Networking capabilities vary widely with each computer, network, and configuration. Whenever you run a Dat there are several steps to share or download files with peers: + +1. Discovering Peers +2. Connecting to Peers +3. Sending & Receiving Data + +With successful use, Dat will show `Connected to 1 peer` after connection. If you never see a peer connected your network may be restricting discovery or connection. Please try using the `dat --doctor` command (see below) between the two computers not connecting. This will help troubleshoot the networks. + +* Dat may [have issues](https://github.com/maxogden/dat/issues/503) connecting if you are using iptables. + +#### Dat Doctor + +We've included a tool to identify network issues with Dat, the Dat doctor. You will need to run the command on both the computers you are trying to share data between. On the first computer, run: + +``` +dat --doctor +``` + +The doctor will print out a command to run on the other computer, `dat --doctor=<64-character-string>`. The doctor will run through the key steps in the process of sharing data between computers to help identify the issue. + +--- ## Ecosystem @@ -96,6 +243,10 @@ For more information, see the [dat project documentation](http://docs.dat-data.c * [dat-desktop](https://github.com/juliangruber/dat-desktop): desktop application * [dat.land](https://github.com/datproject/dat.land): website application +Dat embraces the Unix philosophy: a modular design with composable parts. All of the pieces can be replaced with alternative implementations as long as they implement the abstract API. + +--- + ## For Developers Please see [guidelines on contributing](https://github.com/maxogden/dat/blob/master/CONTRIBUTING.md) before submitting an issue or PR. @@ -115,7 +266,7 @@ The contribution guide also has more tips on our [development workflow](https:// ### Internal API -**Note: we are in the process of moving the main library to a separate module, [joehand/dat-js](https://github.com/joehand/dat-js). Temp documentation here for developers.** +**Note: we are in the process of moving the js library to a separate module, [joehand/dat-js](https://github.com/joehand/dat-js).** #### dat.download(cb) @@ -188,3 +339,7 @@ dat.appendStats = { dirs: 0 } ``` + +## License + +BSD-3-Clause \ No newline at end of file diff --git a/docs/meta/changelog.md b/changelog.md similarity index 100% rename from docs/meta/changelog.md rename to changelog.md diff --git a/docs/meta/collaborators.md b/collaborators.md similarity index 100% rename from docs/meta/collaborators.md rename to collaborators.md diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index 46403480..00000000 --- a/docs/api.md +++ /dev/null @@ -1,51 +0,0 @@ - - -# Dat CLI Commands & Options - -1. Share: `dat ` -2. Download: `dat ` - -## Sharing - -`dat ` - -Share directory in live mode. - -#### Share Options - -`dat --snapshot` - -Share a snapshot of the current files. - -`dat --port=1234` - -Set your inbound TCP port. This is useful for debugging or on restrictive networks. - -## Downloading - -`dat ` - -Download files from a dat-link into a local directory. The Dat CLI accepts both 64 character links or 50 character encoded links. - -### Download Options - -`dat --exit` - -After files are done downloading, exit the process. If you are connected to a live Dat you will not get new files unless you run the command again. - -`dat --port=1234` - -Set your inbound TCP port. This is useful for debugging or on restrictive networks. - -## General Options - -* `dat --version`: get the version of dat you are running. -* `dat --doctor`: visit the doctor to help identify connectivity issues. -* `dat --quiet`: output only dat-link, no progress information -* `dat --debug`: show debugging output - -# Local Storage - -When you run a command, Dat creates a hidden folder, `.dat`, in the directory specified. Similar to git, this folder stores information about that Dat. File metadata and the dat-link are stored to make it easy to resume sharing or downloading the same directory. - -If you have trouble sharing/downloading in a directory with a `.dat` folder, try deleting it (and let us know what the problem was). diff --git a/docs/assets/extra.css b/docs/assets/extra.css deleted file mode 100644 index b1f46c2a..00000000 --- a/docs/assets/extra.css +++ /dev/null @@ -1,19 +0,0 @@ -.wy-side-nav-search { - background-color: #35b44f; -} - -body { - font-size: 1em; -} - -code, .hljs-tag, .hljs-built_in, .hljs-tag .hljs-title, .hljs-rule .hljs-property, .django .hljs-tag, .hljs-keyword, .css .rule .hljs-keyword, .hljs-winutils, .nginx .hljs-title, .hljs-subst, .hljs-request, .hljs-status, .hljs-comment, .diff .hljs-header, .hljs-javadoc { - font-weight: normal; - font-style: normal; - color: #111; - font-size: 16px; -} - -h3, h4, h5, h6 { - color: #6A7380; - margin-top: 1em; -} diff --git a/docs/index.md b/docs/index.md deleted file mode 120000 index 42061c01..00000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -README.md \ No newline at end of file diff --git a/docs/usage.md b/docs/usage.md deleted file mode 100644 index 7ecb306a..00000000 --- a/docs/usage.md +++ /dev/null @@ -1,65 +0,0 @@ - -***Please note we are actively seeking feedback & developing this 1.0 release candidate (formally RC2).*** - -## Installation - -To install the 1.0 release candidate from npm: - -``` -npm install -g dat -``` - -If you receive an `EACCES` error read [this guide](https://docs.npmjs.com/getting-started/fixing-npm-permissions). - -## Using Dat - -Dat makes it simple to share files or data across many computers. Dat commands are always `dat . The source can be files on your computer or files shared via a dat-link. - -Dat RC2 has two default commands: - -1. `dat ` will share a directory to a dat-link. -2. `dat ` will download a dat-link to a directory. - -### Sharing Files - -Share a directory by typing `dat `: - -``` -$ dat my_data/ -Sharing /Users/joe/my_data - -Share Link: d6e1875598fae25165eff440ffd01513197ad0db9dbb9898f2a141288b9322c6 -The Share Link is secret and only those you share it with will be able to get the files - -[==============>] Added 21 files (448.41 MB/448.41 MB) - -Connected to 2 peers. Uploading 5 mBd/s. Watching for updates... -``` - -You are now publishing that data from your computer. It will be publicly accessible as long as your terminal is open. The hash is a **secret hash**, your data is visible to anyone you send the hash to. As you add more files to the folder, dat will update and share the new files. - -### Downloading Files - -You can download data by typing `dat `: - -``` -$ dat d6e1875598fae25165eff440ffd01513197ad0db9dbb9898f2a141288b9322c6 download_dir -Downloading in /Users/joe/Downloads/download_dir - -Share Link: d6e1875598fae25165eff440ffd01513197ad0db9dbb9898f2a141288b9322c6 -The Share Link is secret and only those you share it with will be able to get the files - -[===> ] Downloading 180 files (79.01 kB/498.4 MB) - -Connected to 0 peers. Downloading 10 mB/s. Watching for updates... -``` - -It will start downloading the data into the `download_dir` folder. Anyone who gets access to the unique dat-link will be able to download and re-host a copy of the data. It's distributed mad science! - -## Live Sync & Snapshots - -Dat makes it easy to share a folder and send files as they are added to the folder. By default, when you share using `dat my_data/` you will be in live sync mode. Anyone connected to you will receive new files. - -A snapshot reads the files and creates a specific link that will never change (as long as the files don't change). To create a snapshot use the snapshot option: `dat my_data/ --snapshot`. Snapshots are automatically created for you in live mode. - -When downloading a Dat, you do not have to worry about live mode. It will automatically start in the right mode based on the link. diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 74bb0a45..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,10 +0,0 @@ -site_name: Dat Project CLI -theme: readthedocs -pages: -- "Introduction": 'index.md' -- "Getting Started": 'usage.md' -- "Full Usage": 'api.md' -- Meta: - - 'Changelog': 'meta/changelog.md' - - 'Collaborators': 'meta/collaborators.md' -extra_css: [assets/extra.css] From 811cac53aac91aaa2433071050dad774b34cd4c4 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 17:41:10 -0700 Subject: [PATCH 02/15] move development status note down --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f83bad2d..c144b529 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,6 @@ Windows | Mac/Linux The Dat command line interface can be used to share, download, and sync files across many computers. -### CLI Development Status - -This is the Dat CLI 1.0 release candidate (RC2). We are actively seeking feedback & developing this release candidate. Follow [this issue](https://github.com/datproject/projects/issues/5) for the Dat CLI road map discussion and see [known RC2 issues](https://github.com/maxogden/dat/issues/486). - -**Please note** that previous versions of Dat (alpha, beta) are incompatible with the 1.0 release candidate. - ### Install To use Dat you will need to have [node and npm installed](https://docs.npmjs.com/getting-started/installing-node). Once you have npm, you can install Dat with npm: @@ -90,10 +84,17 @@ For this example, we are going to download the Dat documentation files. In your **put gif here** +### CLI Development Status + +This is the Dat CLI 1.0 release candidate (RC2). We are actively seeking feedback & developing this release candidate. Follow [this issue](https://github.com/datproject/projects/issues/5) for the Dat CLI road map discussion and see [known RC2 issues](https://github.com/maxogden/dat/issues/486). + +**Please note** that previous versions of Dat (alpha, beta) are incompatible with the 1.0 release candidate. + ## Using Dat The Dat command line interface makes it simple to share files or data across many computers. The source can be files on your computer or files shared via Dat on another computer. + There are two commands in Dat: 1. Share data: `dat ` will share a directory on your computer. From be2fef5e815cde42ec4efdda033be14f1fff57e4 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 17:42:30 -0700 Subject: [PATCH 03/15] put example command on own line --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c144b529..dbc54fdf 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,13 @@ You tell Dat what files to download by giving it a Dat link. Dat links are 64 ch Along with the link, you need to tell Dat what directory to download the files to. All together, you can download files by typing `dat `. -For this example, we are going to download the Dat documentation files. In your console, run `dat 395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2 dat_docs` and you should see the output below. Once the download is finished, the files will be available on your computer! +For this example, we are going to download the Dat documentation files. In your console, run: + +``` +dat 395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2 dat_docs +``` + +You should see the output below. Once the download is finished, the files will be available on your computer in the `dat_docs` folder! **put gif here** From d7874bc993fa4753b451bc1dd28488da7e2590c8 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 17:48:10 -0700 Subject: [PATCH 04/15] code formatting --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dbc54fdf..57798870 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ The `-g` option installs Dat globally allowing you to run it as a command. Running `dat` in the console, with no arguments, should show you the usage guide: -```bash +``` dat share directory and create a dat-link @@ -76,9 +76,9 @@ If the `dat` command does not work, there may have been issues in your installat We have Dat installed, now let's use it! In this quick demo we will download our documentation files using Dat. -You tell Dat what files to download by giving it a Dat link. Dat links are 64 character strings, for example 395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2. +You tell Dat what files to download by giving it a Dat link. Dat links are 64 character strings, for example `395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2`. -Along with the link, you need to tell Dat what directory to download the files to. All together, you can download files by typing `dat `. +Along with the link, you tell Dat where to download the files. All together, you can download files by typing `dat `. For this example, we are going to download the Dat documentation files. In your console, run: From 0a497a20c16a6d6f24a497540a0e82c6a60a5fe9 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 18:03:35 -0700 Subject: [PATCH 05/15] cleanup language --- README.md | 48 +++++++++++++++++++----------------------------- 1 file changed, 19 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 57798870..2cb10ac7 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,13 @@ Dat is a decentralized data tool for distributing data small and large. [![datproject/discussions](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/datproject/discussions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![docs](https://img.shields.io/badge/Dat%20Project-Docs-green.svg)](http://docs.dat-data.com) -Windows | Mac/Linux --------------- | ------------ -[![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) - ### Key features: - * **Live sync** folders by sharing files as they are added to the folder. + * **Live sync** folders by sharing files as they are added or changed. * **Distribute large files** without copying data to a central server by connecting directly to peers. * **Intelligently sync** by deduplicating data between versions. * **Verify data integrity** using strong cryptographic hashes. - * **Work everywhere**, including in the [browser](https://github.com/datproject/dat.land) and on the [desktop](https://github.com/juliangruber/dat-desktop). + * **Work everywhere**, including on the [command line](https://github.com/maxogden/dat), in the [browser](https://github.com/datproject/dat.land), and on the [desktop](https://github.com/juliangruber/dat-desktop). ## Table of Contents @@ -33,11 +29,15 @@ Windows | Mac/Linux ## Getting Started -The Dat command line interface can be used to share, download, and sync files across many computers. +The Dat command line tool can be used to share, download, and sync files across many computers. + +Windows | Mac/Linux +-------------- | ------------ +[![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) ### Install -To use Dat you will need to have [node and npm installed](https://docs.npmjs.com/getting-started/installing-node). Once you have npm, you can install Dat with npm: +To use the Dat command line tool you will need to have [node and npm installed](https://docs.npmjs.com/getting-started/installing-node). Once you have npm, you can install Dat with npm: ``` npm install -g dat @@ -80,7 +80,7 @@ You tell Dat what files to download by giving it a Dat link. Dat links are 64 ch Along with the link, you tell Dat where to download the files. All together, you can download files by typing `dat `. -For this example, we are going to download the Dat documentation files. In your console, run: +We have our Dat documentation folders being shared by Dat (at the key above). For this example, we can download those files to your computer. In your console, run: ``` dat 395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2 dat_docs @@ -98,9 +98,6 @@ This is the Dat CLI 1.0 release candidate (RC2). We are actively seeking feedbac ## Using Dat -The Dat command line interface makes it simple to share files or data across many computers. The source can be files on your computer or files shared via Dat on another computer. - - There are two commands in Dat: 1. Share data: `dat ` will share a directory on your computer. @@ -122,7 +119,7 @@ The Share Link is secret and only those you share it with will be able to get th Connected to 1 peers. Uploading 288.2 B/s. Watching for updates... ``` -You are now publishing that data from your computer. It will be publicly accessible as long as your terminal is open and the process is still running. The hash is a **secret hash**, your data is visible to anyone you send the hash to. As you add more files to the folder, Dat will update and share the new files. +You are now publishing that data from your computer. It will be publicly accessible as long as your terminal is open and the process is still running. The hash is a **secret hash**, your data is visible to anyone you send the hash to. #### Updating Shared Files @@ -130,7 +127,7 @@ Dat makes it easy to share a folder and send files as they are added to the fold #### Creating a snapshot -A snapshot reads the files and creates a unique link that will always be the same for that set of files (if they remain unedited). To create a snapshot use the snapshot option: `dat my_data/ --snapshot`. Snapshots are automatically created for you in live mode. +A snapshot reads the files and creates a unique link that will always be the same for that set of files (if they remain unchanged). To create a snapshot use the snapshot option: `dat my_data/ --snapshot`. Snapshots are automatically created for you in live mode as files update. #### Sharing Options @@ -160,11 +157,11 @@ Connected to 1 peers. Downloading 1.44 kB/s. Watching for updates... Dat will start downloading the data into the `download_dir` folder. Once the download is finished (a message will print and the bar will turn green), you can safely exit the process with `Ctrl-C` (`Cmd-C` on Mac). -While downloading, you may be connected to more than 1 peer. Anyone who has the Dat link will be able to download and re-host a copy of the data. So you may be downloading from (and sharing to) other people that are also doing this tutorial! You only need one block of data to start helping as a host. It's distributed mad science! +While downloading, you may be connected to more than 1 peer. Anyone who has the Dat link will be able to download and re-host a copy of the data. So you may be downloading from (and sharing to) other people that are also downloading that data! You only need one block of data to start helping as a host. It's distributed mad science! #### Updating the Downloaded Files -What happens if the files get updated? Dat auto-syncs new files. So if you still have the process open it will download the new files. If you exited the process, you can run the same command you ran before (with the same link and directory) and the files will update! +What happens if the files get updated? IfDat auto-syncs new files if it is still running. If you exited the process, you can run the same command you ran before (with the same link and directory) and the files will update! #### Download Options @@ -176,22 +173,15 @@ After files are done downloading, exit the process. If you are connected to a li Set your inbound TCP port. This is useful for debugging or on restrictive networks. -### Additional Usage Options - -* `dat --version`: get the version of Dat you are running. -* `dat --doctor`: visit the doctor to help identify connectivity issues. -* `dat --quiet`: output only dat-link, no progress information -* `dat --debug`: show debugging output +### Live Sync & Snapshots -#### Live Sync & Snapshots - -Dat makes it easy to share a folder and send files as they are changed or added to the folder. By default, when you share using Dat you will be in *live sync* mode. Anyone connected to you will receive file changes as you make them. - -A snapshot reads the files and creates a specific link that will never change (as long as the files don't change). To create a snapshot use the snapshot option: `dat my_data/ --snapshot`. Snapshots are automatically created for you in live mode. +Dat makes it easy to share a folder and send files as they are changed or added. By default, when you share using Dat you will be in *live sync* mode. Anyone connected to you will receive file changes as you make them. When downloading a Dat, you do not have to worry about live mode. It will automatically start in the right mode based on the link. -#### Local Storage +To create a snapshot when sharing files use the snapshot option: `dat my_data/ --snapshot`. A snapshot reads the files and creates a specific link that will never change (as long as the files don't change). + +### Dat Metadata Storage When you run a command, Dat creates a hidden folder, `.dat`, in the directory specified. Similar to git, this folder stores information about your Dat. File metadata and the Dat link are stored to make it easy to continue sharing or downloading the same directory. @@ -213,7 +203,7 @@ dat -v You should see the Dat semantic version printed, e.g. 11.1.2. -### Install Issues +### Installation Issues * If you receive an `EACCES` error, read [this guide](https://docs.npmjs.com/getting-started/fixing-npm-permissions) on fixing npm permissions. * Have other installation issues? Let us know, you can [open an issue](https://github.com/maxogden/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions). From c9c4910498e3ebc4f5970dd7ecb50fb1fb708bd0 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 21:59:12 -0700 Subject: [PATCH 06/15] cleanup intro and move toc down --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2cb10ac7..6e664b01 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,18 @@ Dat is a decentralized data tool for distributing data small and large. * **Intelligently sync** by deduplicating data between versions. * **Verify data integrity** using strong cryptographic hashes. * **Work everywhere**, including on the [command line](https://github.com/maxogden/dat), in the [browser](https://github.com/datproject/dat.land), and on the [desktop](https://github.com/juliangruber/dat-desktop). - -## Table of Contents + +### [Documentation](https://docs.dat-data.com) | [Video Demo](#) | [Awesome Dat](https://github.com/clkao/awesome-dat) | [dat.land](https://dat.land) + +--- + +## Getting Started + +This guide will help you get started with the Dat command line tool. We are also developing [web](https://github.com/datproject/dat.land) and [desktop](https://github.com/juliangruber/dat-desktop) applications for Dat. + +The Dat command line tool can be used to share, download, and sync files across many computers via the command line. + +### Table of Contents
    Table of Contents @@ -25,11 +35,8 @@ Dat is a decentralized data tool for distributing data small and large.
  • For Developers
    • ---- - -## Getting Started - -The Dat command line tool can be used to share, download, and sync files across many computers. + +[![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) Windows | Mac/Linux -------------- | ------------ From 98ba15e1f20964f3a4e0a106c6a3f063b239708b Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 22:03:14 -0700 Subject: [PATCH 07/15] move badges --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6e664b01..d9ab1241 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,11 @@ This guide will help you get started with the Dat command line tool. We are also The Dat command line tool can be used to share, download, and sync files across many computers via the command line. + +Windows | Mac/Linux | Latest Version +-------------- | ------------ | ------------ +[![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) | [![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) + ### Table of Contents
    @@ -35,13 +40,6 @@ The Dat command line tool can be used to share, download, and sync files across
  • For Developers
    • - -[![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) - -Windows | Mac/Linux --------------- | ------------ -[![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) - ### Install To use the Dat command line tool you will need to have [node and npm installed](https://docs.npmjs.com/getting-started/installing-node). Once you have npm, you can install Dat with npm: From 8a682a0272dbba24db5ea5b8354ad2f00d6c7536 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Thu, 25 Aug 2016 22:06:42 -0700 Subject: [PATCH 08/15] Be sincere, Be brief, Be seated. -fdr --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d9ab1241..41b33718 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ This guide will help you get started with the Dat command line tool. We are also The Dat command line tool can be used to share, download, and sync files across many computers via the command line. -Windows | Mac/Linux | Latest Version +Windows | Mac/Linux | Version -------------- | ------------ | ------------ [![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) | [![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) From 298b63d5e0e73f01d64070a267066620aca30194 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Fri, 26 Aug 2016 16:30:44 -0700 Subject: [PATCH 09/15] add gif and use old video link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 41b33718..c3f33811 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Dat is a decentralized data tool for distributing data small and large. * **Verify data integrity** using strong cryptographic hashes. * **Work everywhere**, including on the [command line](https://github.com/maxogden/dat), in the [browser](https://github.com/datproject/dat.land), and on the [desktop](https://github.com/juliangruber/dat-desktop). -### [Documentation](https://docs.dat-data.com) | [Video Demo](#) | [Awesome Dat](https://github.com/clkao/awesome-dat) | [dat.land](https://dat.land) +### [Documentation](https://docs.dat-data.com) | [Video Demo](https://www.youtube.com/watch?v=fxKjSyCoqO4) | [Awesome Dat](https://github.com/clkao/awesome-dat) | [dat.land](https://dat.land) --- @@ -93,7 +93,7 @@ dat 395e3467bb5b2fa083ee8a4a17a706c5574b740b5e1be6efd65754d4ab7328c2 dat_docs You should see the output below. Once the download is finished, the files will be available on your computer in the `dat_docs` folder! -**put gif here** +![Download gif](https://raw.githubusercontent.com/datproject/docs/master/assets/cli_download.gif) ### CLI Development Status From 317c7b2a20bc9b908d954c2bf689478be7cb4dbf Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Sat, 27 Aug 2016 11:49:18 -0700 Subject: [PATCH 10/15] update with karissa comments --- README.md | 89 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 47 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index c3f33811..85b11459 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Dat is a decentralized data tool for distributing data small and large. * **Verify data integrity** using strong cryptographic hashes. * **Work everywhere**, including on the [command line](https://github.com/maxogden/dat), in the [browser](https://github.com/datproject/dat.land), and on the [desktop](https://github.com/juliangruber/dat-desktop). -### [Documentation](https://docs.dat-data.com) | [Video Demo](https://www.youtube.com/watch?v=fxKjSyCoqO4) | [Awesome Dat](https://github.com/clkao/awesome-dat) | [dat.land](https://dat.land) +### [Documentation](http://docs.dat-data.com) | [Video Demo](https://www.youtube.com/watch?v=fxKjSyCoqO4) | [Ecosystem](https://github.com/clkao/awesome-dat) --- @@ -24,58 +24,25 @@ This guide will help you get started with the Dat command line tool. We are also The Dat command line tool can be used to share, download, and sync files across many computers via the command line. - Windows | Mac/Linux | Version -------------- | ------------ | ------------ [![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) | [![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) -### Table of Contents - -
    - Table of Contents -
  • Getting Started
    • -
  • Using Dat
    • -
  • Troubleshooting
    • -
  • Dat Ecosystem
    • -
  • For Developers
    • -
    - -### Install - -To use the Dat command line tool you will need to have [node and npm installed](https://docs.npmjs.com/getting-started/installing-node). Once you have npm, you can install Dat with npm: +### Installation: ``` npm install -g dat ``` -The `-g` option installs Dat globally allowing you to run it as a command. - -Running `dat` in the console, with no arguments, should show you the usage guide: - -``` -dat - - share directory and create a dat-link - - --snapshot create a snapshot of directory - --port, -p set a specific inbound tcp port - -dat - - download a dat-link into directory - - --exit exit process after download finishes - --port, -p set a specific inbound tcp port - -general options +You should be able to run the `dat` command now. If not, see the [installation troubleshooting](#troubleshooting) for tips. - --version, -v get installed dat version - --doctor run dat doctor - --quiet, -q output only dat-link, no progress information - --debug show debugging output -``` +### Table of Contents -If the `dat` command does not work, there may have been issues in your installation, see the [installation troubleshooting](#troubleshooting). +
  • Getting Started
    • +
  • Using Dat
    • +
  • Troubleshooting
    • +
  • Dat Ecosystem
    • +
  • For Developers
    • ### Demo @@ -108,6 +75,31 @@ There are two commands in Dat: 1. Share data: `dat ` will share a directory on your computer. 2. Download data: `dat ` will download files from the Dat link to a directory on your computer. +Running `dat` in the console, with no arguments, will show you the usage guide. You can always use this as a reference for all the commands: + +``` +dat + + share directory and create a dat-link + + --snapshot create a snapshot of directory + --port, -p set a specific inbound tcp port + +dat + + download a dat-link into directory + + --exit exit process after download finishes + --port, -p set a specific inbound tcp port + +general options + + --version, -v get installed dat version + --doctor run dat doctor + --quiet, -q output only dat-link, no progress information + --debug show debugging output +``` + ### Sharing Files Share a directory by typing `dat `: @@ -210,6 +202,19 @@ You should see the Dat semantic version printed, e.g. 11.1.2. ### Installation Issues +#### Node & npm + +To use the Dat command line tool you will need to have [node and npm installed](https://docs.npmjs.com/getting-started/installing-node). Make sure those are installed correctly before installing Dat. You can check the version of each: + +``` +node -v +npm -v +``` + +#### Global Install + +The `-g` option installs Dat globally allowing you to run it as a command. Make sure you installed with that option. + * If you receive an `EACCES` error, read [this guide](https://docs.npmjs.com/getting-started/fixing-npm-permissions) on fixing npm permissions. * Have other installation issues? Let us know, you can [open an issue](https://github.com/maxogden/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions). From 23d3b7273ef65b42949b90ecbdfa3de6443dfcfb Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Sat, 27 Aug 2016 14:02:11 -0700 Subject: [PATCH 11/15] remove ecosystem section --- README.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/README.md b/README.md index 85b11459..37bae833 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,6 @@ You should be able to run the `dat` command now. If not, see the [installation t
  • Getting Started
  • Using Dat
  • Troubleshooting
    • -
  • Dat Ecosystem
  • For Developers
    • ### Demo @@ -242,18 +241,6 @@ The doctor will print out a command to run on the other computer, `dat --doctor= --- -## Ecosystem - - * [Hyperdrive](https://github.com/mafintosh/hyperdrive): on-disk database format - * [Discovery Swarm](https://github.com/mafintosh/discovery-swarm): discovery mechanism - * [dat-js](https://github.com/joehand/dat-js): javascript library - * [dat-desktop](https://github.com/juliangruber/dat-desktop): desktop application - * [dat.land](https://github.com/datproject/dat.land): website application - -Dat embraces the Unix philosophy: a modular design with composable parts. All of the pieces can be replaced with alternative implementations as long as they implement the abstract API. - ---- - ## For Developers Please see [guidelines on contributing](https://github.com/maxogden/dat/blob/master/CONTRIBUTING.md) before submitting an issue or PR. From 134322af190a2360fafa753bc1d12172b964a22c Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Sat, 27 Aug 2016 14:03:06 -0700 Subject: [PATCH 12/15] move toc up and add CLI title --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 37bae833..b052ba15 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,19 @@ Dat is a decentralized data tool for distributing data small and large. --- -## Getting Started +## Dat Command Line Tool This guide will help you get started with the Dat command line tool. We are also developing [web](https://github.com/datproject/dat.land) and [desktop](https://github.com/juliangruber/dat-desktop) applications for Dat. +### Table of Contents + +
  • Getting Started
    • +
  • Using Dat
    • +
  • Troubleshooting
    • +
  • For Developers
    • + +## Getting Started + The Dat command line tool can be used to share, download, and sync files across many computers via the command line. Windows | Mac/Linux | Version @@ -36,13 +45,6 @@ npm install -g dat You should be able to run the `dat` command now. If not, see the [installation troubleshooting](#troubleshooting) for tips. -### Table of Contents - -
  • Getting Started
    • -
  • Using Dat
    • -
  • Troubleshooting
    • -
  • For Developers
    • - ### Demo We have Dat installed, now let's use it! In this quick demo we will download our documentation files using Dat. From e820a517da15a89300ecc9e1c6130e61be9ded68 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Sat, 27 Aug 2016 14:05:19 -0700 Subject: [PATCH 13/15] remove : from install title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b052ba15..7d4d7fdc 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Windows | Mac/Linux | Version -------------- | ------------ | ------------ [![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) | [![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) -### Installation: +### Installation ``` npm install -g dat From 612c76c58d5a8cf2e0442768d36a9c6ad24203e8 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Mon, 29 Aug 2016 10:32:42 -0700 Subject: [PATCH 14/15] add note about sudo install --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7d4d7fdc..fe0c3798 100644 --- a/README.md +++ b/README.md @@ -217,6 +217,7 @@ npm -v The `-g` option installs Dat globally allowing you to run it as a command. Make sure you installed with that option. * If you receive an `EACCES` error, read [this guide](https://docs.npmjs.com/getting-started/fixing-npm-permissions) on fixing npm permissions. +* If you receive an `EACCES` error, you may also install dat with sudo: `sudo npm install -g dat`. * Have other installation issues? Let us know, you can [open an issue](https://github.com/maxogden/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions). ### Networking Issues From 76be7b27fde6fd2847b6d7a8e47acef860994ec8 Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Mon, 29 Aug 2016 10:40:43 -0700 Subject: [PATCH 15/15] update github urls to datproject/dat --- README.md | 16 ++++++++-------- package.json | 6 +++--- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fe0c3798..d60c8409 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Dat is a decentralized data tool for distributing data small and large. * **Distribute large files** without copying data to a central server by connecting directly to peers. * **Intelligently sync** by deduplicating data between versions. * **Verify data integrity** using strong cryptographic hashes. - * **Work everywhere**, including on the [command line](https://github.com/maxogden/dat), in the [browser](https://github.com/datproject/dat.land), and on the [desktop](https://github.com/juliangruber/dat-desktop). + * **Work everywhere**, including on the [command line](https://github.com/datproject/dat), in the [browser](https://github.com/datproject/dat.land), and on the [desktop](https://github.com/juliangruber/dat-desktop). ### [Documentation](http://docs.dat-data.com) | [Video Demo](https://www.youtube.com/watch?v=fxKjSyCoqO4) | [Ecosystem](https://github.com/clkao/awesome-dat) @@ -35,7 +35,7 @@ The Dat command line tool can be used to share, download, and sync files across Windows | Mac/Linux | Version -------------- | ------------ | ------------ -[![Build status](https://ci.appveyor.com/api/projects/status/github/maxogden/dat?branch=master&svg=true)](https://ci.appveyor.com/project/maxogden/dat) | [![Travis](https://api.travis-ci.org/maxogden/dat.svg)](https://travis-ci.org/maxogden/dat) | [![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) +[![Build status](https://ci.appveyor.com/api/projects/status/github/datproject/dat?branch=master&svg=true)](https://ci.appveyor.com/project/datproject/dat) | [![Travis](https://api.travis-ci.org/datproject/dat.svg)](https://travis-ci.org/datproject/dat) | [![NPM version](https://img.shields.io/npm/v/dat.svg?style=flat-square)](https://npmjs.org/package/dat) ### Installation @@ -65,7 +65,7 @@ You should see the output below. Once the download is finished, the files will b ### CLI Development Status -This is the Dat CLI 1.0 release candidate (RC2). We are actively seeking feedback & developing this release candidate. Follow [this issue](https://github.com/datproject/projects/issues/5) for the Dat CLI road map discussion and see [known RC2 issues](https://github.com/maxogden/dat/issues/486). +This is the Dat CLI 1.0 release candidate (RC2). We are actively seeking feedback & developing this release candidate. Follow [this issue](https://github.com/datproject/projects/issues/5) for the Dat CLI road map discussion and see [known RC2 issues](https://github.com/datproject/dat/issues/486). **Please note** that previous versions of Dat (alpha, beta) are incompatible with the 1.0 release candidate. @@ -185,7 +185,7 @@ When you run a command, Dat creates a hidden folder, `.dat`, in the directory sp ## Troubleshooting -We've provided some troubleshooting tips based on issues users have seen. Please [open an issue](https://github.com/maxogden/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions) if you need help troubleshooting and it is not covered here. +We've provided some troubleshooting tips based on issues users have seen. Please [open an issue](https://github.com/datproject/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions) if you need help troubleshooting and it is not covered here. If you have trouble sharing/downloading in a directory with a `.dat` folder, try deleting it and running the command again. @@ -218,7 +218,7 @@ The `-g` option installs Dat globally allowing you to run it as a command. Make * If you receive an `EACCES` error, read [this guide](https://docs.npmjs.com/getting-started/fixing-npm-permissions) on fixing npm permissions. * If you receive an `EACCES` error, you may also install dat with sudo: `sudo npm install -g dat`. -* Have other installation issues? Let us know, you can [open an issue](https://github.com/maxogden/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions). +* Have other installation issues? Let us know, you can [open an issue](https://github.com/datproject/dat/issues/new) or ask us in our [chat room](https://gitter.im/datproject/discussions). ### Networking Issues @@ -230,7 +230,7 @@ Networking capabilities vary widely with each computer, network, and configurati With successful use, Dat will show `Connected to 1 peer` after connection. If you never see a peer connected your network may be restricting discovery or connection. Please try using the `dat --doctor` command (see below) between the two computers not connecting. This will help troubleshoot the networks. -* Dat may [have issues](https://github.com/maxogden/dat/issues/503) connecting if you are using iptables. +* Dat may [have issues](https://github.com/datproject/dat/issues/503) connecting if you are using iptables. #### Dat Doctor @@ -246,7 +246,7 @@ The doctor will print out a command to run on the other computer, `dat --doctor= ## For Developers -Please see [guidelines on contributing](https://github.com/maxogden/dat/blob/master/CONTRIBUTING.md) before submitting an issue or PR. +Please see [guidelines on contributing](https://github.com/datproject/dat/blob/master/CONTRIBUTING.md) before submitting an issue or PR. ### Installing from source @@ -258,7 +258,7 @@ npm link This should add a `dat` command line command to your PATH. Now you can run the `dat` command to try it out. -The contribution guide also has more tips on our [development workflow](https://github.com/maxogden/dat/blob/master/CONTRIBUTING.md#development-workflow). +The contribution guide also has more tips on our [development workflow](https://github.com/datproject/dat/blob/master/CONTRIBUTING.md#development-workflow). ### Internal API diff --git a/package.json b/package.json index 62d32f50..ce84a7af 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ }, "repository": { "type": "git", - "url": "git://github.com/maxogden/dat.git" + "url": "git://github.com/datproject/dat.git" }, "author": "max ogden", "license": "BSD-3-Clause", @@ -44,9 +44,9 @@ "yolowatch": "^2.3.0" }, "bugs": { - "url": "https://github.com/maxogden/dat/issues" + "url": "https://github.com/datproject/dat/issues" }, - "homepage": "https://github.com/maxogden/dat", + "homepage": "https://github.com/datproject/dat", "directories": { "test": "tests" },