diff --git a/Evernote.md b/Evernote.md new file mode 100644 index 0000000..1f10b84 --- /dev/null +++ b/Evernote.md @@ -0,0 +1,114 @@ +# Using ever2boost +[ever2boost](https://github.com/BoostIO/ever2boost) is a CLI tool for conversion Evernote to Boostnote. + +
+ +
+ +# Quick start +Get Evernote developer token from [here](https://www.evernote.com/api/DeveloperToken.action). + +``` +$ gem install ever2boost +$ ever2boost import +DEVELOPER_TOKEN: +``` + +Limitation? Go [here](docs/api_error.md) + +## Connect to your Boostnote +You need to connect it to Boostnote. Go Menu -> Add Storage and add it. + +![how_to_add_storage](https://raw.githubusercontent.com/BoostIO/ever2boost/master/docs/images/img2.png) + +And select your storage. It's at `~/evernote_storage` by default on `import`. + +![how_to_chose_the_directory](https://raw.githubusercontent.com/BoostIO/ever2boost/master/docs/images/img3.png) + +**** + +## ever2boost command +Ever2boost has 2 commands for conversion `convert` and `import`. + +``` +$ ever2boost -h +Commands: + ever2boost convert # convert from .enex + ever2boost help [COMMAND] # Describe available commands or one specific co... + ever2boost import # import from evernote +``` + +### Create notes storage from Evernote +First, you need to create new Boostnote storage by ever2boost. And you can choose which command do you use, `import` or `convert`. + +#### import +Import all of notes from cloud storage at Evernote. + +`import` command has 1 option `d` which specify output directory. + +``` +$ ever2boost help import +Usage: + ever2boost import + +Options: + d, [--directory=DIRCTORY_PATH] # make Boostnote storage in the directory default: ~/evernote_storage + +import from evernote +``` + +1. get your developer token from https://www.evernote.com/api/DeveloperToken.action +![how_to_get_your_developer_token](https://raw.githubusercontent.com/BoostIO/ever2boost/master/docs/images/img1.png) + +2. run `ever2boost import` + +``` +$ ever2boost import +DEVELOPER_TOKEN: +``` +And `import` will start. It uses EvernoteAPI, thus you should take care access limitations. + +#### convert +Convert notes from `.enex` file which is **exported file from Evernote**. + +You can get how to export from [official document](https://help.evernote.com/hc/en-us/articles/209005557-How-to-back-up-export-and-restore-import-notes-and-notebooks). + +`convert` has 1 option `d` which specify output directory. + +``` +$ ever2boost help convert +Usage: + ever2boost convert + +Options: + d, [--directory=DIRCTORY_PATH] # make Boostnote storage in the directory default: ~/evernote_storage + +convert from .enex +``` + +## Requirements +Ruby: 2.0.0 or above +bundler: Corresponding to Ruby + +if you don't have bundler: + +``` +$ gem install bundler +``` + +> if it fails by permission, you can run as sudo (perhaps you're using preinstalled Ruby in the OS) + + + +## Something happens +If your Boostnote would be broken: + +* Notes and folders disappear +* Folder names are something wrong (e.g: Unknown 1) + +First of all, look over [this document](docs/emergency.md). After that, if you would not find how to solve your error, please report an issue. + +## Contributing +Bug reports and pull requests are welcome on GitHub at https://github.com/BoostIO/ever2boost. + +More information: [how_to_develop_ever2boost](docs/development.md)