README.mdown in zocial-0.0.2 vs README.mdown in zocial-0.0.3
- old
+ new
@@ -1,22 +1,21 @@
-# Zocial: CSS3 Buttons, Sass Framework.
+# Zocial, a CSS3 social buttons Sass framework.
-## Zocial is a CSS3 button set and vector icons with @font-face bundled as a Sass framework.
+## Zocial is a CSS3 social buttons set and vector icons with @font-face as a Sass mixin and usable as a Compass extension.
HUGE thanks to [Sam Collins](http://twitter.com/smcllns) for all his hard work on the original CSS3 button set and the Zocial icons font! Without his work, this project would not exist.
-You can find the CSS only version (no Sass) and the full font set at [zocial.smcllns.com](http://zocial.smcllns.com/). This project comes with a free subset of that font set, and includes:
+This project comes with a free subset of that font set, and includes:
* Twitter
* Facebook
* Google+
* GitHub
* RSS
* Smashing Magazine
+* and MANY more ...
-
-
## Installation
The first step is to install the Ruby gem. If you are not yet setup to work with Sass and Compass, please see the [getting started guide](http://thesassway.com/beginner/getting-started-with-sass-and-compass) at [The Sass Way](http://thesassway.com/).
(sudo) gem install zocial
@@ -32,55 +31,70 @@
You should see something like this:
-> % compass install zocial/fonts
directory fonts/zocial/
- create fonts/zocial/zocial-lite-regular-webfont.eot
- create fonts/zocial/zocial-lite-regular-webfont.svg
- create fonts/zocial/zocial-lite-regular-webfont.ttf
- create fonts/zocial/zocial-lite-regular-webfont.woff
+ create fonts/zocial/zocial-regular-webfont.eot
+ create fonts/zocial/zocial-regular-webfont.svg
+ create fonts/zocial/zocial-regular-webfont.ttf
+ create fonts/zocial/zocial-regular-webfont.woff
Once you've done this, your project will be ready to use Zocial! The next step is to "mixin" Zocial which is covered in the usage section.
## Usage
-Zocial Buttons is delivered with a few default variables in place you can override to fine tune Zocial for your project.
+Zocial has a few defaults in place that you can override for your project.
// Defaults
$zocial-font-size: 1.8em
- $zocial-icon-font: zocial-lite
- $zocial-icon-default: "-"
+ $zocial-font-weight: bold
+ $zocial-icon-font: zocial
+ $zocial-icon-default: "\0020"
$zocial-text-font: helvetica
+
+`$zocial-font-size` is set using ems and will vary in size based on your default font size.
-Based on the default variables, you can set `$zocial-icon-font` to `zocial` if you own the full set. This will also unfurl the styles for the full set as well as Zocial-Lite. Keep in mind that if you use the full set in your project, you are still bound by the license terms of the full set even though this framework is open source.
+`$zocial-icon-font` is set to "zocial" by default. In a previous version, there was a "lite" version of the font offered as open source, but now the full Zocial font is now included as open source and you can use all the buttons zocial has to offer.
-You can also set the `$zocial-font-size` to something larger or smaller than the default of 1.8em.
+`$zocial-icon-default` is set to an empty space by default. Feel free to update this if you plan to use a default button and want to set a default icon.
-Last but not least, you can set the `$zocial-text-font` to something other than Helvetica. The font family choices are listed below. In a future release, we plan to work on adding better options for using other fonts. Please be patient.
+`$zocial-text-font` is set to "helvetica" by default, but can set to [any of the fonts](https://github.com/adamstac/zocial/blob/master/stylesheets/partials/_fonts.sass) defined. In a future release, we plan to work on adding better options for using other fonts. Please be patient.
+### Mixins
+
+Once you have Zocial's settings in place, it's time to mixin zocial. Zocial has two mixins, one for the free set (zocial-lite) and one for the full set (zocial-full) that can [purchased here](http://zocial.smcllns.com/).
+
+To use the free set that comes with this project, use this mixin:
+
+ // SCSS
+ @include zocial;
+
+ // Sass
+ +zocial
+
## HTML Markup
Here's a snippet of example HTML markup in both HTML and Haml. The caveat or gotcha that most people stumble over is the required nested `<span>` element. As you can see, each Zocial button gets the required `.zocial` class name plus the button name.
- <button class="zocial icon twitter">
+ <button class="zocial twitter">
<span>Sign in with Twitter</span>
</button>
- <a class="zocial icon twitter" href="#">
+ <a class="zocial twitter" href="#">
<span>Sign in with Twitter</span>
</a>
- %button.zocial.icon.twitter
+ %button.zocial.twitter
%span Sign in with Twitter
- %a(href="#" class="zocial icon twitter")
+ %a(href="#" class="zocial twitter")
%span Sign in with Twitter
To use just the icon version of the Zocial button, all you need to do is add the class name `.icon` to the above markup. Here's is the repeated code, but this time adding the `.icon` class.
- <button class="zocial twitter">
+ <button class="zocial icon twitter">
<span>Sign in with Twitter</span>
</button>
- <a class="zocial twitter" href="#">
+ <a class="zocial icon twitter" href="#">
<span>Sign in with Twitter</span>
</a>
%button.zocial.icon.twitter
%span Sign in with Twitter
@@ -100,10 +114,10 @@
## Font Family Choices
**Icon font:**
-* zocial-lite
+* zocial
**Text font:**
* helvetica
* arial (alias to helvetica)
\ No newline at end of file