Skip to content

Commit

Permalink
chore: Update the framework scaffold README to be more accurate
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Trost committed Jun 29, 2015
1 parent 37ff033 commit 8be5a28
Showing 1 changed file with 2 additions and 14 deletions.
16 changes: 2 additions & 14 deletions lib/framework/scaffold/templates/_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,6 @@ Then surf to [localhost:1618](http://localhost:1618) ...

## Deploying

Note: Before you can deploy your component, you must...
Once you're ready to deploy your component, run

1.) Register for a Famous Hub account (`$ famous register`). You can skip this step if you've already done it before. If you aren't sure, check for a `.famous/.config` file in your home directory.

2.) Be working with a component whose namespace matches your username. I.e. if your component is `jon-doe:my-component`, then your username must be `jon-doe` exactly for the push to succeed.

Once you have this all set up, you are ready to deploy to a container!

First, save a snapshot of the desired component to deploy:

$ npm run snapshot-component -- -n jon-doe:my-component

Then, use the Famous CLI to push to a container:

$ famous deploy public/jon-doe:my-component
$ famous deploy

0 comments on commit 8be5a28

Please sign in to comment.