Started writing up v3 README #3091

Merged
merged 1 commit into from Aug 4, 2016

Projects

None yet

5 participants

@scott-w
Member
scott-w commented Aug 2, 2016

Proposed changes

  • Changes to the README for v3

Summary

I'm using this PR to propose changes to the README. If there's anything you think is important, put it here and I'll update this PR with the information.

@scott-w scott-w Started writing up v3 README
Started changing the text to refer to v3, pulling together all the
links (which won’t work yet), improving dependency information, and
linking to the relevant guides.
82d04c8
@coveralls
coveralls commented Aug 2, 2016 edited

Coverage Status

Coverage remained the same at 100.0% when pulling 82d04c8 on scott-w:v3readme into d4598ae on marionettejs:next.

@JSteunou
Contributor
JSteunou commented Aug 3, 2016

So exciting 🎆

@rafde rafde commented on the diff Aug 4, 2016
readme.md
@@ -126,24 +138,23 @@ You can read the annotations for all the details of how Marionette works, and ad
MarionetteJS currently works with the following libraries:
* [jQuery](http://jquery.com) v1.8+
-* [Underscore](http://underscorejs.org) v1.4.4 - 1.6.0
-* [Backbone](http://backbonejs.org) v1.0.0 - 1.1.2 are preferred.
-* [Backbone.Radio](https://github.com/marionettejs/backbone.radio) Comes automatically with the bundled build.
-* [Backbone.BabySitter](https://github.com/marionettejs/backbone.babysitter) Comes automatically with the bundled build.
+* [Underscore](http://underscorejs.org) v1.8.3
@rafde
rafde Aug 4, 2016 Member

Lodash 4 core compatible?

@paulfalgout paulfalgout commented on the diff Aug 4, 2016
readme.md
@@ -80,30 +84,38 @@ We're happy to discuss design patterns and learn how you're using Marionette.
<a href="https://github.com/marionettejs/marionette.inspector"><img src="http://i.imgur.com/B1q9QXH.jpg" align="center" /></a>
@paulfalgout
paulfalgout Aug 4, 2016 Member

so the inspector is kind of broken right now and isn't going to work with v3.. maybe we should pull it for now?

@paulfalgout paulfalgout commented on the diff Aug 4, 2016
readme.md
@@ -126,24 +138,23 @@ You can read the annotations for all the details of how Marionette works, and ad
MarionetteJS currently works with the following libraries:
* [jQuery](http://jquery.com) v1.8+
-* [Underscore](http://underscorejs.org) v1.4.4 - 1.6.0
-* [Backbone](http://backbonejs.org) v1.0.0 - 1.1.2 are preferred.
-* [Backbone.Radio](https://github.com/marionettejs/backbone.radio) Comes automatically with the bundled build.
-* [Backbone.BabySitter](https://github.com/marionettejs/backbone.babysitter) Comes automatically with the bundled build.
+* [Underscore](http://underscorejs.org) v1.8.3
+* [Backbone](http://backbonejs.org) v1.3.3
+* [Backbone.Radio](https://github.com/marionettejs/backbone.radio) Comes bundled (v1.0.0)
+* [Backbone.BabySitter](https://github.com/marionettejs/backbone.babysitter) Comes bundled (v1.0.0)
@paulfalgout
paulfalgout Aug 4, 2016 Member

this line can go :-)

@scott-w
scott-w Aug 4, 2016 Member

Shall I chop the Radio line too?

@paulfalgout
paulfalgout Aug 4, 2016 Member

I didn't actually remove Radio as a dependency in package.json. I still kinda think it's cool to keep it as default. People can alias it out if need be right? But <script> tag users can add Mn without having to worry about Radio day one.

@scott-w scott-w added the docs label Aug 4, 2016
@scott-w scott-w modified the milestone: v3.0.0 Aug 4, 2016
@paulfalgout paulfalgout merged commit 6ec1a9f into marionettejs:next Aug 4, 2016

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 100.0%
Details
@ahumphreys87 ahumphreys87 added a commit to ahumphreys87/backbone.marionette that referenced this pull request Aug 21, 2016
@scott-w @ahumphreys87 scott-w + ahumphreys87 Started writing up v3 README (#3091)
Started changing the text to refer to v3, pulling together all the
links (which won’t work yet), improving dependency information, and
linking to the relevant guides.
d63c19b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment