Remove generated API docs from the README #69
Conversation
README.md
Outdated
|
|
||
| To publish: | ||
| [MIT](https://github.com/canjs/can-set/blob/master/LICENSE.md) |
There was a problem hiding this comment.
This should be https://github.com/canjs/can-set/blob/master/LICENSE
| 2. Run `npm publish`. This should generate the dist folder. | ||
| 3. Create and checkout a "release" branch. | ||
| 4. Run `git add -f dist`. | ||
| 5. Commit the addition and tag it `git tag v0.2.0`. Push the tag `git push origin --tags`. |
There was a problem hiding this comment.
We’ll need to make sure that docs like these are moved to CONTRIBUTING.md
There was a problem hiding this comment.
This is a more concise version of that we already have in the CONTRIBUTING.md file, with two differences, it uses test.html in addition to npm test, and it includes publishing instructions. Should we update all CONTRIBUTING.mds to use this as well?
README.md
Outdated
| environments. [can-connect](http://connect.canjs.com) uses can-set to create data modeling | ||
| utilities and middleware for the client. | ||
|
|
||
| [Play around in this JSBin!](https://justinbmeyer.jsbin.com/faveda/4/edit?js,console) |
There was a problem hiding this comment.
We should be keeping everything in this description.
README.md
Outdated
|
|
||
| - __returns__ <code>{[Compares](#compares-objectstringproppropavalue-bvalue-a-b-prop-algebra)}</code>: | ||
| A set compares object that can do the translation. | ||
| Read the [API docs on CanJS.com](https://canjs.com/doc/can-set.html). |
There was a problem hiding this comment.
For future runs of the codemod, it might be nice to have the package name in the link, e.g. “Read the can-set API docs on CanJS.com”
imaustink
force-pushed
the
dev-rel-12-update-generated-readmes
branch
3 times, most recently
from
db5914b to
4e432c0
Compare
imaustink
force-pushed
the
dev-rel-12-update-generated-readmes
branch
from
4e432c0 to
e44cc7c
Compare
imaustink
force-pushed
the
dev-rel-12-update-generated-readmes
branch
from
e44cc7c to
973a785
Compare
This pull request was created with Landscaper.
The following code mods were used to create this PR:
Please review this PR carefully as Landscaper does not guarantee any code mod's quality.