Skip to content

Commit

Permalink
updated package version and cleaned up readme to state that BF git re…
Browse files Browse the repository at this point in the history
…po is for employees only
  • Loading branch information
samthurman committed Feb 8, 2016
1 parent 0551ad4 commit 3dc3d6a
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 14 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,13 @@ Solid is a base style library. It will be used as the core styling for Buzzfeed
## Including Solid in Your Project

### Dependencies
You must have NPM installed. If you have installed the [Buzzfeed webapp](https://github.com/buzzfeed/buzzfeed) congrats! You already do.
You must have NPM installed.

### Install
When inside your project directory type:
```
npm install bf-solid --save
```
or using Bower:
```
bower install git+ssh://git@github.com/buzzfeed/solid.git#<RELEASE_VERSION> --save
```

This will give you `solid.scss` and all of its scss files inside `node_modules/solid/lib`. This package includes the static, uncompiled SCSS files. Whether you want to build them into your project with Grunt, Gulp, etc. is up to you.

Expand Down Expand Up @@ -49,14 +45,12 @@ Solid is broken up into four sections:

You can get everything with `@import "solid";`. Individual sections can also be imported. For example if you want the utility classes just `@import "solid-utilities";`

## Building the Solid Styleguide
The solid styleguide lets you view Solid along with all of its documentation.

## Set Up the Styleguide Locally (optional)
## Developing Solid
The Solid styleguide lets you view Solid along with all of its documentation. Access to the Solid git repo is restricted to BuzzFeed employees. If you are not a BuzzFeed employee check out the Solid docs [online](http://solid.buzzfeed.com/).

### Dependencies

This installation guide assumes that you have the [Buzzfeed webapp](https://github.com/buzzfeed/buzzfeed) installed. That will set you up with the correct versions of node and ruby.
This installation guide assumes that you have the [BuzzFeed webapp](https://github.com/buzzfeed/buzzfeed) installed. That will set you up with the correct versions of node and ruby.

### Downloading the repo

Expand Down
6 changes: 3 additions & 3 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ <h2 class="bold xs-mb2">Installation</h2>

<h3 class="bold xs-mb2">Download</h3>
<p>
<a href="dist/solid.1.4.2.zip" download class="xs-mr1 button button--secondary">Source Files</a>
<a href="dist/solid.1.4.2.css" download class="xs-mr1 button button--secondary">Compiled CSS</a>
<a href="dist/solid.1.4.2.min.css" download class="xs-mr1 button button--secondary">Compiled CSS (minified)</a>
<a href="dist/solid.1.4.3.zip" download class="xs-mr1 button button--secondary">Source Files</a>
<a href="dist/solid.1.4.3.css" download class="xs-mr1 button button--secondary">Compiled CSS</a>
<a href="dist/solid.1.4.3.min.css" download class="xs-mr1 button button--secondary">Compiled CSS (minified)</a>
</p>

</section>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bf-solid",
"version": "1.4.2",
"version": "1.4.3",
"description": "Solid CSS Styling",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
Expand Down
15 changes: 15 additions & 0 deletions release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,21 @@

<div class="release--container clearfix xs-col-12 xs-mb2 xs-pb1">

<div class="release clearfix xs-mb2 xs-pb1 xs-border-bottom--lighter">
<div class="col xs-col-2 lg-col-1 text-gray--lightest">
1.5.0-alpha
</div>

<div class="col xs-col-10 lg-col-11">
<h4 class="bold xs-mb1 text-grey--lightest">Under Development</h4>
<ul>
<li class="xs-mb1"></li>
</ul>

</div>
</div>


<div class="release clearfix xs-mb2 xs-pb1 xs-border-bottom--lighter">
<div class="col xs-col-2 lg-col-1 text-gray--lightest">
1.4.3
Expand Down

0 comments on commit 3dc3d6a

Please sign in to comment.