Rename 'Polymer Starter Kit' to 'Share With Me'

This commit is contained in:
Robin Linus 2015-12-18 17:09:04 +01:00
parent f5b2b47136
commit 370003835e
10 changed files with 38 additions and 133 deletions

View file

@ -2,7 +2,7 @@
Although support for ES2015 (formerly ES6) is improving in modern browsers, the majority do not yet support the full set of features. To benefit from the awesomeness of the new ES2015 syntax while keeping backwards compatibility with Polymer's supported browsers, you'll need to transpile your JS code from ES2015 to ES5
This recipe focuses on adding an ES2015 to ES5 transpile step to Polymer Starter Kit's build pipeline using [BabelJS](https://babeljs.io/).
This recipe focuses on adding an ES2015 to ES5 transpile step to Share With Me's build pipeline using [BabelJS](https://babeljs.io/).
## Create a transpile gulp task

View file

@ -1,8 +1,8 @@
# Use Polymer Starter Kit on Chrome Dev Editor
# Use Share With Me on Chrome Dev Editor
If you are using a Chromebook, one of the few IDE you can use is [Chrome Dev Editor](https://github.com/GoogleChrome/chromedeveditor).
To use the Polymer Starter Kit you have to download the [latest release](https://github.com/PolymerElements/polymer-starter-kit/releases) in the `light` flavor (the additional tools can't be used from CDE).
To use the Share With Me you have to download the [latest release](https://github.com/PolymerElements/polymer-starter-kit/releases) in the `light` flavor (the additional tools can't be used from CDE).
After downloading the `polymer-starter-kit-light-*.zip` file unpack it in a new folder (for Example `psk-light`) you should have a directory structure like

View file

@ -1,6 +1,6 @@
# Deploy to Firebase using Pretty URLs
Firebase is a very simple and secure way to deploy a Polymer Starter Kit site. You can sign up for a free account and deploy your application in less than 5 minutes.
Firebase is a very simple and secure way to deploy a Share With Me site. You can sign up for a free account and deploy your application in less than 5 minutes.
The instructions below are based on the [Firebase hosting quick start
guide](https://www.firebase.com/docs/hosting/quickstart.html).
@ -64,4 +64,4 @@ guide](https://www.firebase.com/docs/hosting/quickstart.html).
The URL to your live site is listed in the output.
You can see a demo of Polymer Starter Kit hosted on Firebase using pretty URLs at https://polymer-starter-kit.firebaseapp.com.
You can see a demo of Share With Me hosted on Firebase using pretty URLs at https://polymer-starter-kit.firebaseapp.com.

View file

@ -1,6 +1,6 @@
# Deploy to Github Pages
You can deploy to github pages with a couple minor changes to Polymer Starter Kit:
You can deploy to github pages with a couple minor changes to Share With Me:
1. Uncomment this line `// app.baseUrl = '/polymer-starter-kit/';` in app.js near the top
@ -19,5 +19,5 @@ You can deploy to github pages with a couple minor changes to Polymer Starter Ki
### Notes
* When deploying to Github Pages we recommend using hashbangs which is Polymer Starter Kit default.
* When deploying to Github Pages we recommend using hashbangs which is Share With Me default.
* This method should work for most hosting providers when using a subfolder.

View file

@ -1,21 +1,21 @@
# Use Polymer Starter Kit for [Mobile Chrome Apps](https://github.com/MobileChromeApps/mobile-chrome-apps)
# Use Share With Me for [Mobile Chrome Apps](https://github.com/MobileChromeApps/mobile-chrome-apps)
## Getting started
Polymer Starter Kit could be fully adapted to Mobile Chrome Apps through mobile-friendly features. Mobile Chrome Apps, is based on Apache Cordova, and requires mobile application SDKs such as Android and iOS. so please make sure that installation development tool by following [installation guide](https://github.com/MobileChromeApps/mobile-chrome-apps/blob/master/docs/Installation.md) of Mobile Chrome Apps. And then, You do some further steps to resolve some of restrictions and configurations to use Polymer Starter Kit on Cordova. Looking for a [guide video](https://www.youtube.com/watch?v=-ifgyobPLVg) below to better understand.
Share With Me could be fully adapted to Mobile Chrome Apps through mobile-friendly features. Mobile Chrome Apps, is based on Apache Cordova, and requires mobile application SDKs such as Android and iOS. so please make sure that installation development tool by following [installation guide](https://github.com/MobileChromeApps/mobile-chrome-apps/blob/master/docs/Installation.md) of Mobile Chrome Apps. And then, You do some further steps to resolve some of restrictions and configurations to use Share With Me on Cordova. Looking for a [guide video](https://www.youtube.com/watch?v=-ifgyobPLVg) below to better understand.
[![](https://camo.githubusercontent.com/7c498c4d60113dd1ea072576df897283100428b6/687474703a2f2f696d672e796f75747562652e636f6d2f76692f2d696667796f62504c56672f302e6a7067)](https://www.youtube.com/watch?v=-ifgyobPLVg)
## Download Polymer Starter Kit into your workspace
## Download Share With Me into your workspace
To download and preparation, follow this [guide of Polymer Starter Kit](https://github.com/PolymerElements/polymer-starter-kit#getting-started). Make sure that install all of dependencies of npm and Bower.
To download and preparation, follow this [guide of Share With Me](https://github.com/PolymerElements/polymer-starter-kit#getting-started). Make sure that install all of dependencies of npm and Bower.
## Create a Cordova project
Create a Cordova project in path `polymer-starter-kit` by following command. `platform` is the path for Cordova project files, `com.your.app` is the project name/id and next following string is the description for your app.
```sh
cca create platform com.your.app "Your Polymer Starter Kit App"
cca create platform com.your.app "Your Share With Me App"
```
If you have no problems while creating a project you will seeing the message of installing successful coming from Cordova and have the tree of the project below.
@ -52,7 +52,7 @@ You need to have some changes of configuration to fit for Mobile Chrome Apps as
### Configure path for app built by gulp
- Change the path `dist` in `gulpfile.js` from `dist` to `platform/www/app`, then the app built with Polymer Starter Kit will be placed under `platform/www` will be used by Cordova.
- Change the path `dist` in `gulpfile.js` from `dist` to `platform/www/app`, then the app built with Share With Me will be placed under `platform/www` will be used by Cordova.
```js
var DIST = 'platform/www/app';
```
@ -118,7 +118,7 @@ You need to have some changes of configuration to fit for Mobile Chrome Apps as
## Build and run app
After done of above steps. run this command on root path that let you see Chrome Apps built with Polymer Starter Kit.
After done of above steps. run this command on root path that let you see Chrome Apps built with Share With Me.
```sh
gulp && cd platform && cca run chrome