Hawk/README.md

# Hawk
The missing Firefox OS file manager

This app is under heavy development, things may change and break, but don't hesitate to test and fill issues in case you find bugs.

Please read the Features section below and issues to make sure your issue is not already listed.

Firefox OS 2.2 and up are supported. Sadly 2.0 and 1.3 miss a lot of ES6 functionalities as well as CSS3 features (flexbox, etc) which break our application.

![Mobile Portrait Mockup](https://github.com/mdibaiee/Hawk/raw/master/Mobile%20Portrait.png)

# Thanks to

Sergio Muriel [@tfeserver](https://twitter.com/tfeserver) for testing application
Mohammad Jahani [@mamal72](https://twitter.com/mamal72) for ideas, and helping in designing the [webpage](http://dibaiee.ir/Hawk)

# Frequently Asked Questions

**Q: Why does Hawk create an `.empty` file inside new folders I create?**

This happens on Firefox OS devices below version 3, and that's because the API doesn't allow
listing empty folders, in order to show you the folder, Hawk has to fake the folder to have a child.


**Q: Why is Hawk slow?**

Hawk is much faster on Firefox OS 3.0 and up, and that's because the way old Device Storage API works,
it's slow by nature. Nothing we can do about it, sadly.


# Features

Version 1.0
-----------
- [x] Breadcrumb
- [x] Delete Files
- [x] Refresh
- [x] Rename Files
- [x] Error dialogs
- [x] Show / Hide hidden files
- [x] Show directories first
- [x] Create new files and directories
- [x] File Size
- [x] Directory Child Count
- [x] Actions on multiple files (selection)
- [x] Copy and Paste/Move files
- [x] File Preview (Supports PDF files!)
- [x] Filter Files
- [x] Swipe Gestures (Up directory by swiping right)
- [x] Search
- [x] First-run Tour
- [x] Share Files
- [x] Pick files


Version 2.0
------------
- [x] Different views (List, Grid)
- [ ] Show storage usage statistics (free/used)
- [ ] Sort Files
- [ ] Zip / Unzip
- [ ] Image Thumbnails
- [ ] FTP Browser
- [ ] Preferences
- [ ] File Type Icons
- [ ] Wi-Fi File Transfer (is this possible?)
Initial commit 2015-08-29 19:17:42 +00:00			`# Hawk`
			`The missing Firefox OS file manager`
fix dialog.delete: deleteDialog doesn't have to say the filename, for now. docs README: updated README 2015-09-03 11:27:48 +00:00
			`This app is under heavy development, things may change and break, but don't hesitate to test and fill issues in case you find bugs.`

fix docs: update README, typo and sort features by priority 2015-09-03 22:38:22 +00:00			`Please read the Features section below and issues to make sure your issue is not already listed.`
fix dialog.delete: deleteDialog doesn't have to say the filename, for now. docs README: updated README 2015-09-03 11:27:48 +00:00
fix compatibility: We're not going to support 2.0 and below 2015-09-07 18:51:17 +00:00			`Firefox OS 2.2 and up are supported. Sadly 2.0 and 1.3 miss a lot of ES6 functionalities as well as CSS3 features (flexbox, etc) which break our application.`

fix docs: Damn, I had forgotten Markdown syntax 2015-09-07 23:15:09 +00:00			`![Mobile Portrait Mockup](https://github.com/mdibaiee/Hawk/raw/master/Mobile%20Portrait.png)`
feat docs: Add mockup to README 2015-09-07 23:13:52 +00:00
fix file.create: don't create an .empty folder on devices with new API support feat docs: add Frequently Asked Questions section 2015-09-14 08:12:50 +00:00			`# Thanks to`
fix build: use babel/polyfill instead of babelify 2015-09-07 14:48:10 +00:00
fix docs: update #Thanks to section 2015-09-07 15:06:12 +00:00			`Sergio Muriel [@tfeserver](https://twitter.com/tfeserver) for testing application`
fix docs: add Mohammad Jahani to #thanks to section 2015-09-08 14:22:45 +00:00			`Mohammad Jahani [@mamal72](https://twitter.com/mamal72) for ideas, and helping in designing the [webpage](http://dibaiee.ir/Hawk)`
fix build: use babel/polyfill instead of babelify 2015-09-07 14:48:10 +00:00
fix file.create: don't create an .empty folder on devices with new API support feat docs: add Frequently Asked Questions section 2015-09-14 08:12:50 +00:00			`# Frequently Asked Questions`

			Q: Why does Hawk create an `.empty` file inside new folders I create?

			`This happens on Firefox OS devices below version 3, and that's because the API doesn't allow`
			`listing empty folders, in order to show you the folder, Hawk has to fake the folder to have a child.`


			`Q: Why is Hawk slow?`

			`Hawk is much faster on Firefox OS 3.0 and up, and that's because the way old Device Storage API works,`
			`it's slow by nature. Nothing we can do about it, sadly.`


fix dialog.delete: deleteDialog doesn't have to say the filename, for now. docs README: updated README 2015-09-03 11:27:48 +00:00			`# Features`

update docs: Version 2 features 2015-09-07 11:20:40 +00:00			`Version 1.0`
			`-----------`
docs README: Refresh and Breadcrumb are done 2015-09-03 11:28:57 +00:00			`- [x] Breadcrumb`
fix dialog.delete: deleteDialog doesn't have to say the filename, for now. docs README: updated README 2015-09-03 11:27:48 +00:00			`- [x] Delete Files`
docs README: Refresh and Breadcrumb are done 2015-09-03 11:28:57 +00:00			`- [x] Refresh`
fix rename: Fixed Renaming Directories not working properly feat dialogs.error: Added Error dialogs to show errors 2015-09-03 22:26:33 +00:00			`- [x] Rename Files`
			`- [x] Error dialogs`
feat navigation: style checkboxes in navigation feat preferences: Show Hidden Files and Show Directories First options working 2015-09-04 01:05:14 +00:00			`- [x] Show / Hide hidden files`
			`- [x] Show directories first`
feat files: Create files and Directories fix styles.shadows: Follow Material Design's shadow and elevation guide, I like it. 😍 2015-09-04 10:27:45 +00:00			`- [x] Create new files and directories`
feat files: Show File Size and Directory's sub items count fix styles: make thin-small 15px instead of 14px (was too small) 2015-09-04 11:02:03 +00:00			`- [x] File Size`
			`- [x] Directory Child Count`
feat multiselection: select multiple files and act on them fix breadcrumb: fixed breadcrumb history not working properly when clicking on "sdcard" fix dialogs/menus: fixed clicking out of menus and dialogs triggering actions other than hiding the dialog/event 2015-09-05 11:39:09 +00:00			`- [x] Actions on multiple files (selection)`
feat search: search files, depth-first feat files.view: Open files using Web Activities feat copy/paste: Copy and Paste/Move files fix filters: add "all" filter which clears filters out 2015-09-06 11:23:48 +00:00			`- [x] Copy and Paste/Move files`
feat tour: Show new users around 2015-09-06 13:02:50 +00:00			`- [x] File Preview (Supports PDF files!)`
feat search: search files, depth-first feat files.view: Open files using Web Activities feat copy/paste: Copy and Paste/Move files fix filters: add "all" filter which clears filters out 2015-09-06 11:23:48 +00:00			`- [x] Filter Files`
			`- [x] Swipe Gestures (Up directory by swiping right)`
			`- [x] Search`
fix tour: fix event listeners not working properly 2015-09-06 13:08:25 +00:00			`- [x] First-run Tour`
feat share: Ability to share files using Web Activities feat pick: Ability to pick files for other apps 2015-09-07 10:48:53 +00:00			`- [x] Share Files`
			`- [x] Pick files`
update docs: Version 2 features 2015-09-07 11:20:40 +00:00

			`Version 2.0`
			`------------`
fix docs: update todo-list, bump version and rebuild 2015-09-09 09:00:05 +00:00			`- [x] Different views (List, Grid)`
Improve compatibility with old versions - Remove starting "/sdcard/" from file paths on old Firefox OS versions - Cache results for faster navigation on old Firefox OS devices 2015-09-15 12:56:07 +00:00			`- [ ] Show storage usage statistics (free/used)`
update docs: Version 2 features 2015-09-07 11:20:40 +00:00			`- [ ] Sort Files`
			`- [ ] Zip / Unzip`
			`- [ ] Image Thumbnails`
fix dialog.delete: deleteDialog doesn't have to say the filename, for now. docs README: updated README 2015-09-03 11:27:48 +00:00			`- [ ] FTP Browser`
update docs: Version 2 features 2015-09-07 11:20:40 +00:00			`- [ ] Preferences`
fix dialog.delete: deleteDialog doesn't have to say the filename, for now. docs README: updated README 2015-09-03 11:27:48 +00:00			`- [ ] File Type Icons`
fix docs: sort features again 2015-09-04 11:57:33 +00:00			`- [ ] Wi-Fi File Transfer (is this possible?)`