README.md in sass-zero-0.0.7 vs README.md in sass-zero-0.0.8

- old
+ new

@@ -1,51 +1,80 @@ -# Sass::Zero +# SASS-ZERO -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sass/zero`. To experiment with that code, run `bin/console` for an interactive prompt. +SASS-ZERO is a css framework that brings concepts from [tailwindcss](https://tailwindcss.com) and [milligram](https://milligram.io) but with ideas from [BEM](http://getbem.com/naming), [Refactoring UI](https://refactoringui.com/book) and [Shape UP](https://basecamp.com/shapeup). -TODO: Delete this and the text above, and describe your gem +### Tailwindcss +"Instead of hand-picking values from a limitless pool any time you need to make a decision, start with a smaller set of options." - [Refactoring UI](https://refactoringui.com/book). -## Installation +SASS-ZERO use font, color, spacing, border and etc from [tailwindcss](https://tailwindcss.com) but instead the utility-first approach we use [sass variables](https://sass-lang.com/documentation/variables). -Add this line to your application's Gemfile: +### Milligram +"Programmers don’t need a pixel-perfect design to start implementing. All they need are endpoints: input elements, buttons, places where stored data should appear. These affordances are the core of a user interface design." - [Shape UP](https://basecamp.com/shapeup/3.2-chapter-10#affordances-before-pixel-perfect-screens). -Gemfile +SASS-ZERO comes with a basic grayscale theme that help you to bring your ideas to life, questions about font, color, spacing and layout can be resolved after the raw affordances. +### BEM +I believe that html is code, therefore it should be named and scoped as well. Developers need to be good with naming things, css is another oportunity to practice. + +### Refactoring UI +Developers should be able to produce your own design, [Refactoring UI](https://refactoringui.com/book) is the book for that. + +### Shape UP +SASS-ZERO comes with a implict flow from Shape UP, Find Elemens -> Create Affordance -> Make it Beautiful. + +### Breadboard Theme (Just HTML) +![screenshot](https://nixo-etc.s3-sa-east-1.amazonaws.com/Screenshot_2020-02-17+Routeend.png) + +## Installation + +Add this to your application's Gemfile: + ```ruby gem 'sass-zero' gem 'autoprefixer-rails' ``` -application.css +## Usage +Add this line to your application.css: + ```css *= require sass-zero/base ``` -somefile.scss +Create some stylesheet using [BEM](http://getbem.com/naming) and [SASS-ZERO Variables](https://github.com/lazaronixon/sass-zero/blob/master/vendor/assets/stylesheets/sass-zero/variables.scss): ```scss @import "sass-zero/variables"; @import "sass-zero/mixins"; + +// Block +.block { color: $red-300; } + +// Element +.block__elem { color: $red-400; } + + +// Modifier +.block--mod .block__elem { color: $red-200; } + +.block__elem--mod { color: $red-500; } + ``` -## Usage +## References -TODO: Write usage instructions here +[SASS](https://sass-lang.com) -## Development +[Tailwindcss](https://tailwindcss.com) -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +[Milligram](https://milligram.io) -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). +[BEM](http://getbem.com/naming) -## Contributing +[Refactoring UI](https://refactoringui.com/book) -Bug reports and pull requests are welcome on GitHub at https://github.com/lazaronixon/sass-zero. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +[Shape UP](https://basecamp.com/shapeup) ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). - -## Code of Conduct - -Everyone interacting in the Sass::Zero project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sass-zero/blob/master/CODE_OF_CONDUCT.md).