Skip to content

Commit

Permalink
Fixed some merging issues with links in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tjibbevanderlaan committed May 13, 2018
1 parent 0999c68 commit 8ed5880
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 79 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -2,7 +2,7 @@

### A ChromeOS app which provides the ability to access a SFTP server, directly from the Files app

<img src="https://github.com/tjibbevanderlaan/chromeos-filesystem-sftp/raw/react/docs/screenshot-1.png" title="Shared network folder SFTP app preview" width="600" />
<img src="https://github.com/tjibbevanderlaan/chromeos-filesystem-sftp/raw/master/docs/screenshot-1.png" title="Shared network folder SFTP app preview" width="600" />

## Content
1. [Description](#description)
Expand All @@ -16,12 +16,12 @@
5. [License](#license)

## Description
*Shared network folder (SFTP)* is forked from [yoichiro/chromeos-filesystem-sftp](https://github.com/yoichiro/chromeos-filesystem-sftp/) and provides the ability to access a SFTP server directly from the ChromeOS Files app. The fork has improved the design of the user-interface, to provide a more native look-and-feel. To do so, the front-end build system have been moved from [bower](https://bower.io/), [grunt](https://gruntjs.com/) to [npm](https://www.npmjs.com), [webpack](https://webpack.js.org/) to make use of [React](https://reactjs.org/) and the [Material-UI components](https://material-ui-next.com/).
*Shared network folder (SFTP)* is originally developed by [Yoichiro Tanaka](https://github.com/yoichiro) and provides the ability to access a SFTP server directly from the ChromeOS Files app. My fork has improved the design of the user-interface, to provide a more native look-and-feel. To do so, the front-end build system have been moved from [bower](https://bower.io/), [grunt](https://gruntjs.com/) to [npm](https://www.npmjs.com), [webpack](https://webpack.js.org/) to make use of [React](https://reactjs.org/) and the [Material-UI components](https://material-ui-next.com/). The fork is merged with the original repo.

## Development
*Shared network folder (SFTP)* is a [Chrome App](https://developer.chrome.com/apps/about_apps), therefore explicitly build for ChromeOS systems. Chrome Apps can be created with common web technologies such as HTML5, CSS, and JavaScript to deliver an experience comparable of a native application. To extent the power of these technologies, Chrome delivers a [Native Client SDK](https://developer.chrome.com/native-client/sdk/download) to compile C and C++ code in the browser efficiently and securely, independent of the user’s operating system. *Shared network folder (SFTP)* makes use of [libssh2](https://www.libssh2.org/) which has been ported to the [Native Client](https://developer.chrome.com/native-client) environment to establish a file share connection over SSH (i.e. SFTP; SSH File Transfer Protocol). The compiled code is part of the app, and communicates with the web technologies back and forth.

Please visit the [documentation](https://github.com/tjibbevanderlaan/chromeos-filesystem-sftp/blob/react/docs/documentation.md), to get more insights of the app structure.
Please visit the [documentation](https://github.com/tjibbevanderlaan/chromeos-filesystem-sftp/blob/master/docs/documentation.md), to get more insights of the app structure.

### Getting started
To build the app, you need a 1) build system to compile the app's Native Client code, and a 2) front-end build system to build the app itself.
Expand Down

0 comments on commit 8ed5880

Please sign in to comment.