Merge pull request #154 from styled-components/bump-version

preparations for v4 bump

Author: quantizor

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Vladimir Danchenkov and Maximilian Stoiber
+Copyright (c) 2016-present Vladimir Danchenkov and Maximilian Stoiber
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,11 @@
 # `babel-plugin-styled-components`
 
-This plugin adds support for server-side rendering, for minification of styles and gives you a nicer debugging experience when using `styled-components`.
+This plugin is a highly recommended supplement to the base styled-components library, offering some useful features:
+
+* consistently hashed component classNames between environments (a must for server-side rendering)
+* automatic library usage tweaks that allow for some bytes to be dropped from your bundle
+* better debugging through automatic annotation of your styled components based on their context in the file system, etc.
+* various types of minification for styles and the tagged template literals styled-components uses
 
 ## Quick start
 
@@ -18,18 +23,26 @@ Then add it to your babel configuration:
 }
 ```
 
-## [Documentation](https://www.styled-components.com/docs/tooling#babel-plugin)
+## styled-components v4 beta
+
+If you are using the styled-components v4 beta, you'll also need to use the beta version of this plugin:
+
+```
+npm install --save-dev babel-plugin-styled-components@beta
+```
+
+Older versions should technically work, but some of the bundle size reduction benefits are only realized with the newer code!
+
+## Documentation
 
 **The documentation for this plugin lives on [the styled-components website](https://www.styled-components.com/docs/tooling#babel-plugin)!**
 
-- [Usage](https://www.styled-components.com/docs/tooling#usage)
-- [Server-side rendering](https://www.styled-components.com/docs/tooling#serverside-rendering)
-- [Better debugging](https://www.styled-components.com/docs/tooling#better-debugging)
-- [Minification](https://www.styled-components.com/docs/tooling#minification)
-- [Preprocessing](https://www.styled-components.com/docs/tooling#preprocessing)
+* [Usage](https://www.styled-components.com/docs/tooling#usage)
+* [Better debugging](https://www.styled-components.com/docs/tooling#better-debugging)
+* [Minification](https://www.styled-components.com/docs/tooling#minification)
 
 ## License
 
-Licensed under the MIT License, Copyright © 2016 Vladimir Danchenkov and Maximilian Stoiber.
+Licensed under the MIT License, Copyright © 2016-present Vladimir Danchenkov and Maximilian Stoiber.
 
 See [LICENSE.md](./LICENSE.md) for more information.

minification.md

@@ -6,15 +6,15 @@ Wait, transpiling tagged template literals? Doesn't Babel do this natively?
 
 ## Transpiling tagged template literals
 
-You're currently using Babel to transpile your ES2015 JavaScript to ES5-compliant code. one of your presets (`es2015`/`env`/`latest`) includes the  `babel-plugin-transform-es2015-template-literals` transform to make tagged template literals work in older browsers, but there is a caveat. Output of that plugin is quite wordy. It's done this way to meet specification requirements:
+You're currently using Babel to transpile your ES2015 JavaScript to ES5-compliant code. one of your presets (`es2015`/`env`/`latest`) includes the `babel-plugin-transform-es2015-template-literals` transform to make tagged template literals work in older browsers, but there is a caveat. Output of that plugin is quite wordy. It's done this way to meet specification requirements:
 
 ```JS
 // processed with babel-preset-latest
 
 var _templateObject = _taggedTemplateLiteral(['width: 100%;'], ['width: 100%;']);
 function _taggedTemplateLiteral(strings, raw) { return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
 var Simple = _styledComponents2.default.div(_templateObject);
-```   
+```
 
 `styled-components` styling code does not require full spec compatibility. This plugin will transpile template literals attached to styled-component to a slightly different form which still works in older browsers but has a much smaller footprint.
 
@@ -34,19 +34,21 @@ keyframe``
 css``
 
 // But this will not be converted
-`some text`
+'some text'
 
 // In next example outer template literal will be converted because it's attached to component factory,
 // but inner template literals will not be touched
-styled.div`color: ${ light ? `white` : `black`};`
+styled.div`
+  color: ${ light ? 'white' : 'black'};
+;`
 ```
 
 You can disable this feature with `transpileTemplateLiterals` option:
 
 ```JSON
 {
   "plugins": [
-    ["styled-components", {
+    ["babel-plugin-styled-components", {
       "transpileTemplateLiterals": false
     }]
   ]

package.json

@@ -7,7 +7,7 @@
     "Vladimir Danchenkov <[email protected]>",
     "Max Stoiber <[email protected]>",
     "Phil Pluckthun <[email protected]>",
-    "Evan Scott <[email protected]>"
+    "Evan Jacobs <[email protected]>"
   ],
   "main": "lib/index.js",
   "files": [