stellarskylark/tachyons-skylark
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #616 from ikelands/master

Browse source 
Fix README.md typos
This commit is contained in:
murmurs 2019-10-21 08:46:45 -04:00 committed by GitHub
commit 244c722f1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,8 +1,8 @@
# TACHYONS # TACHYONS
Functional css for humans. Functional CSS for humans.
Quickly build and design new UI without writing css. Quickly build and design new UI without writing CSS.
## Principles ## Principles
@ -13,12 +13,12 @@ Quickly build and design new UI without writing css.
* It should be easy to change any interface or part of an interface without breaking any existing interfaces * It should be easy to change any interface or part of an interface without breaking any existing interfaces
* Doing one thing extremely well promotes reusability and reduces repetition * Doing one thing extremely well promotes reusability and reduces repetition
* Documentation helps promote reusability and shared knowledge * Documentation helps promote reusability and shared knowledge
* Css shouldn't impede accessibility or the default functionality of Html * CSS shouldn't impede accessibility or the default functionality of HTML
* You should send the smallest possible amount of code to the user * You should send the smallest possible amount of code to the user
## Features ## Features
* Mobile-first css architecture * Mobile-first CSS architecture
* 490 accessible color combinations * 490 accessible color combinations
* 8px baseline grid * 8px baseline grid
* Multiple debugging utilities to reduce layout struggles * Multiple debugging utilities to reduce layout struggles
@ -27,19 +27,19 @@ Quickly build and design new UI without writing css.
* Lightweight (~14kB) * Lightweight (~14kB)
* Usable across projects * Usable across projects
* Growing open source component library * Growing open source component library
* Works well with plain html, react, ember, angular, rails, and more * Works well with plain HTML, React, Ember, Angular, Rails and more
* Infinitely nestable responsive grid system * Infinitely nestable responsive grid system
* Built with Postcss * Built with PostCSS
## Getting started ## Getting Started
Docs can be found at http://tachyons.io/docs Docs can be found at http://tachyons.io/docs
The modules are generally pretty small and thus quick and easy to read. The modules are generally pretty small and thus quick and easy to read.
### Use the CDN ### Use the CDN
The quickest and easiest way to start using tachyons is to include a reference The quickest and easiest way to start using Tachyons is to include a reference
to the minified file in the head of your html file. to the minified file in the head of your HTML file.
```html ```html
<link rel="stylesheet" href="https://unpkg.com/tachyons@4/css/tachyons.min.css"> <link rel="stylesheet" href="https://unpkg.com/tachyons@4/css/tachyons.min.css">
@ -47,7 +47,7 @@ to the minified file in the head of your html file.
### Local Setup ### Local Setup
Clone the repo from github and install dependencies through npm. Clone the repo from Github and install dependencies through npm.
``` ```
git clone https://github.com/tachyons-css/tachyons.git git clone https://github.com/tachyons-css/tachyons.git
@ -59,20 +59,20 @@ npm install
If you want to just use everything in tachyons/src as a jumping off point and If you want to just use everything in tachyons/src as a jumping off point and
edit all the code yourself, you can compile all of your wonderful changes by edit all the code yourself, you can compile all of your wonderful changes by
running running:
```npm start``` ```npm start```
This will output both minified and unminified versions of the css to the css directory and watch the src directory for changes. This will output both minified and unminified versions of the CSS to the CSS directory and watch the src directory for changes.
It's aliased to the command: It's aliased to the command:
```npm run build:watch``` ```npm run build:watch```
If you'd like to just build the css once without watching the src directory run If you'd like to just build the CSS once without watching the src directory, run:
```npm run build``` ```npm run build```
If you want to check that a class hasn't been redefined or 'mutated' there is a linter to check that all of the classes have only been defined once. This can be useful if you are using another library or have written some of your own css and want to make sure there are no naming collisions. To do this run the command If you want to check that a class hasn't been redefined or 'mutated,' there is a linter to check that all of the classes have only been defined once. This can be useful if you are using another library or have written some of your own CSS and want to make sure there are no naming collisions. To do this run the command:
```npm run mutations``` ```npm run mutations```
@ -97,7 +97,7 @@ Please read our [code of conduct](https://github.com/tachyons-css/tachyons/blob/
## Tachyons in Production ## Tachyons in Production
A longer list of sites that use tachyons in production can be found in sites.md A longer list of sites that use tachyons in production can be found in sites.md
We love letting the community see what people are building so please add your link to sites.md in a PR or by opening an issue if you're willing to share to your site or project. We love letting the community see what people are building. Please add your link to sites.md in a PR or by opening an issue if you're willing to share to your site or project.
**Featured Sites** **Featured Sites**