voog-kit 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac0a57de7355211889a4cec2cd4c62b405e5f2ac
-  data.tar.gz: 524285b8c42a5f49aa0bfbbdd6e5bb46172e5a82
+  metadata.gz: 6ca9d43de96a85cceacfc9ca445810fff9a51f9c
+  data.tar.gz: 3c9c89d32194b02a8a6cb0eea78c409a102d3a2f
 SHA512:
-  metadata.gz: b47f316dc4afa5877e979e46363c2497047ccb04a9b4beba5694c182466b8967c54d558842ba9f7563c1808aa7efa31b869d757cf202bb7eeba308fd61f7706c
-  data.tar.gz: 2b18928b4acf862ab8857094c1eb007dacd1cea452d19280907edbc298aab3d947ad0bcc9edb4d1fff2de631639062e033169554443eedb00af1af1476aedf5d
+  metadata.gz: fa8c0fc65383f9d0a5bd47cd673ee097f3396de404c2e317322633a159ee4b05172cde28a91e055c3e1112baa8e742667e9b705b0e0ab9208cc23fa46a22f952
+  data.tar.gz: bf8576c04f7c357633196fa44dd8431874140a01cfaa7729d5f9f7a014fc7b02db63062edc1d4fe816af4d3bfe63d1255f620fe6d172315c45e6adca30f03352

data/README.markdown

@@ -38,12 +38,11 @@ at `mysite.voog.com`. This is essentially all you need to get started.
 
 ### Downloading the layout
 
-Let's start.
+`kit pull -h mysite.voog.com -t 0809d0c93c53438d435b2073d2cf2d22` 
 
-`kit pull -h mysite.voog.com -t 0809d0c93c53438d435b2073d2cf2d22` downloads the layout files
-from *mysite.voog.com* using the API token *0809d0c93c53438d435b2073d2cf2d22*. This creates 
-the necessary folders to hold the files, so the file structure stays the same as in the 
-online code editor.
+This downloads the layout files from *mysite.voog.com* using the API token 
+*0809d0c93c53438d435b2073d2cf2d22*. This creates the necessary folders to hold the 
+files, so the file structure stays the same as in the online code editor.
 
 The current folder structure should be something like this:
 ```
@@ -56,15 +55,51 @@ The current folder structure should be something like this:
     stylesheets/
 ```
 
-As you can see, kit also generated a *manifest.json* file to hold the metadata to along with
+As you can see, **kit** also generated a *manifest.json* file to hold the metadata to along with
 the layout files. This is later used when checking for missing files and uploading everything back up.
 
 There's also a *.voog* file that holds your hostname and API token so you don't have to provide them
 every time:
 
+```
+[mysite.voog.com]
+  host=mysite.voog.com
+  api_token=0809d0c93c53438d435b2073d2cf2d22
+  overwrite=false
+```
+
+The site name inside the square brackets, [mysite.voog.com] is set as a default.
+You can change it to whatever you want. If you only have one site to work with within
+the current folder, you don't have to worry about it. When you do, however, have multiple
+sites with the same layout, it's useful to have meaningful names for each configuration block.
+
+To specify which block to use, you can provide it with the `--site` or `-s` options like so:
+
+`kit pull -s mysite.voog.com`
+
+This looks for a configuration file block with the same name
+and uses the hostname and API token given there.
 
 ### Uploading the changes
 
+After making the changes, you'll want to upload them to your site. This is done via `kit push`.
+The possible arguments are same as before: you can provide the hostname and token manually with
+`-h / --host` and `-t / --token`, or just provide the configuration block name found in the *.voog* 
+file with the `-s / --site` option.
+
+Let's use the last option: `kit push --site=mysite.voog.com`. This lists all the files
+that are updated. By default, all files are updated at once, but if you only made changes to a few, you
+can provide them explicitly like so: `kit push stylesheets/main.css javascripts/main.js`. This saves
+time (and bandwidth) as there's only a few files being uploaded.
+
+### Automating
+
+As you've learned, pushing and pulling files is super easy, but it's still something you
+have to do every time you change something and want to see the changes take place.
+To counter this, `kit` provides a handy `watch` command that monitors your local files
+and pushes them up if it sees any changes. The arguments to this command are, again, the
+same as before. To stop watching, just type "exit" or press Ctrl+D.
+
 ## Commands
 
 * `init`     - Initializes the local folder structure and files for a site
@@ -75,32 +110,10 @@ every time:
 * `watch`    - Watches for file changes in the current directory
 * `help`     - Shows a list of commands or help for one command
 
-Most commands need to know your site's URL and you personal API token to properly authorize all
-requests. For this you can either provide them with `--token/-t` and `--host/-h` 
-flags, e.g `kit pull -t 0809d0c93c53438d435b2073d2cf2d22 -h mysite.voog.com`. If there's a '.voog' file
-present in the current folder, it takes the options from there.
-
-There's also a `--site/-s` argument that is used to choose a configuration block from the `.voog` file.
-
-Example `.voog` file:
-
-```
-[site1]
-  host=mysite.voog.com
-  api_token=0809d0c93c53438d435b2073d2cf2d22
-[site2]
-  host=site2.customdomain.co
-  api_token=5d390d7d4552d14afcf30182aecfc815
-```
-
-To choose the second block, you can simply use `kit pull -s site2` or `kit pull --site=site2`.
-If the site is not provided, **kit** will use the first block defined in the file.
-When you provide the host, token and block name, it is then written to the configuration file, overwriting
-any identically named blocks or creating a new one, if necessary.
-
-If the configuration file isn't present and you provide the token, hostname and site name manually when invoking a
-command, the file is then generated and the options are stored within so you don't have to provide them
-later.
+Most of these commands use the same options as shown before:
+`--site / -s` - provide a configuration block name
+`--host / -h` - provide a hostname
+`--token / -t` - provide your API token to authorize all requests
 
 Another useful option is `--overwrite` to allow updating asset files you normally couldn't update. This deletes the 
 old file and uploads the newer one as a replacement. This cannot be undone, so take caution!
@@ -161,30 +174,7 @@ You can stop the watch command by pressing Ctrl+D or typing "exit" or "q".
 This command shows helpful information about the tool or its subcommands. Invoking `kit help` shows a list of possible
 options and commands with a brief description. `kit help <command>` shows information about that command.
 
-### Sample local folder structure
 
-```
-./
-    assets/
-        custom_font.woff
-    components/
-        mainmenu.tpl
-        sidebar.tpl
-        footer.tpl
-    images/
-        background.jpg
-    javascripts/
-        custom_script.js
-        spinner.js
-    layouts/
-        front_page.tpl
-        blog.tpl
-        products.tpl
-    stylesheets/
-        style.css
-    .voog
-    manifest.json
-```
 
 If you want to explicitly use latest version of the [Voog API client](https://github.com/Edicy/voog.rb):
 

data/lib/voog/dtk/version.rb

@@ -1,5 +1,5 @@
 module Voog
   module Dtk
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/voog-kit.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'voog_api', '~> 0.0.7'
   spec.add_runtime_dependency 'colorize'
   spec.add_runtime_dependency 'mime-types', '~> 1.25.1'
+  spec.add_runtime_dependency 'rb-readline'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voog-kit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Mikk Pristavka
@@ -165,6 +165,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tools that help Voog design development
 email:
 - mikk@fraktal.ee