roots-tumblr - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

contributing.md

@@ -1,12 +0,8 @@
-
 # Contributing to Roots-Tumblr
-
 Hello there! First of all, thanks for being interested in this project and helping out. We all think you are awesome, and by contributing to open source projects, you are making the world a better place. That being said, there are a few ways to make the process of contributing code to this project smoother, detailed below:
 
-### Filing Issues
-
+## Filing Issues
 If you are opening an issue about a bug, make sure that you include clear steps for how we can reproduce the problem. _If we can't reproduce it, we can't fix it_. If you are suggesting a feature, make sure your explanation is clear and detailed.
 
-### Getting Set Up
-
+## Getting Set Up
 - Clone the project down
@@ -17,16 +13,13 @@ - Make sure [nodejs](http://nodejs.org) has been installed and is above version `0.10.x`
 
-### Testing
+## Testing
+This project is constantly evolving, and to ensure that things are secure and working for everyone, we need to have tests. If you are adding a new feature, please make sure to add a test for it. The test suite for this project uses [mocha](http://visionmedia.github.io/mocha/) and [should](https://github.com/visionmedia/should.js/).
 
-This project is constantly evolving, and to ensure that things are secure and working for everyone, we need to have tests. If you are adding a new feature, please make sure to add a test for it. The test suite for this project uses [mocha](http://visionmedia.github.io/mocha/) and [should](https://github.com/visionmedia/should.js/)/
-
 To run the test suite, make sure you have installed mocha (`npm install mocha -g`), then you can use the `npm test` or simply `mocha` command to run the tests.
 
-### Code Style
+## Code Style
+To keep a consistant coding style in the project, we're using [Polar Mobile's guide](https://github.com/polarmobile/coffeescript-style-guide). For inline documentation, we're using [JSDoc](http://usejsdoc.org/).
 
-To keep a consistant coding style in the project, we're using [Polar Mobile's guide](https://github.com/polarmobile/coffeescript-style-guide), with one difference begin that much of this project uses `under_scores` rather than `camelCase` for variable naming. For any inline documentation in the code, we're using [JSDoc](http://usejsdoc.org/).
-
-### Commit Cleanliness
-
+## Commit Cleanliness
 It's ok if you start out with a bunch of experimentation and your commit log isn't totally clean, but before any pull requests are accepted, we like to have a nice clean commit log. That means [well-written and clear commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and commits that each do something significant, rather than being typo or bug fixes.
 
 If you submit a pull request that doesn't have a clean commit log, we will ask you to clean it up before we accept. This means being familiar with rebasing - if you are not, [this guide](https://help.github.com/articles/interactive-rebase) by github should help you to get started. And if you are still confused, feel free to ask!

lib/index.js

@@ -10,3 +10,3 @@ // Generated by CoffeeScript 1.7.1
 
-  BLACKLISTED_FILE_EXTENSIONS = ['.jpg', '.gif', '.png', '.css', '.styl', '.js', '.coffee'];
+  BLACKLISTED_FILE_EXTENSIONS = ['.jpg', '.gif', '.png', '.css', '.styl', '.js', '.coffee', '.scss'];
 
@@ -16,4 +16,6 @@ module.exports = function(data) {
     return TumblrCompiler = (function() {
-      function TumblrCompiler() {
-        this.data = {};
+      function TumblrCompiler() {}
+
+      if (data == null) {
+        data = require('./default');
       }
@@ -20,0 +22,0 @@

package.json

 {
   "name": "roots-tumblr",
   "description": "tumblr theme compilation roots",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "Sean Lang <[e-mail]>",
@@ -36,5 +36,5 @@ "dependencies": {
     "coveralls": "make build; istanbul cover _mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage; make unbuild",
-    "lint": "find lib/ -name '*.coffee' | xargs coffeelint",
+    "lint": "find lib -name '*.coffee' | xargs coffeelint",
     "test": "npm run lint && mocha"
   }
 }

README.md

@@ -7,8 +7,7 @@ # Roots Tumblr
 ## Installation
-- make sure you are in a [roots](https://github.com/jenius/roots) project directory
+- ensure you are in a [roots](https://github.com/jenius/roots) project directory
 - `npm install roots-tumblr --save`
-- login to [tumblr](https://www.tumblr.com/login) and go to the URL `https://www.tumblr.com/customize_api/demo_content/YOURBLOGNAME`
-- Save JSON that's returned in a file like `./tumblr-demo-content.json`.
 
 ## Usage
+To use the default [tumblr json export](lib/default.json):
 
@@ -18,2 +17,14 @@ ```coffee
 tumblr = require 'roots-tumblr'
+
+module.exports =
+  extensions: [tumblr()]
+```
+
+To use a custom tumblr json export:
+- login to [tumblr](https://www.tumblr.com/login) and go to the URL `https://www.tumblr.com/customize_api/demo_content/YOURBLOGNAME`
+- Save JSON that's returned in a file like `./tumblr-demo-content.json`.
+
+```coffee
+# app.coffee
+tumblr = require 'roots-tumblr'
 tumblrDemoContent = require './tumblr-content'
@@ -20,0 +31,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

41845

increased by0.24%

Lines of code

38

increased by2.7%

Number of lines in readme file

38

increased by40.74%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes