Merge pull request #27 from canjs/dev-rel-12-update-generated-readmes

Remove generated API docs from the README

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to can-validate-legacy
+
+Check out the [contribution guide on CanJS.com](https://canjs.com/doc/guides/contribute.html) for information on:
+
+- [Code of Conduct](https://canjs.com/doc/guides/contribute.html#CodeofConduct)
+- [Getting Help](https://canjs.com/doc/guides/contribute.html#GettingHelp)
+- [Project Organization](https://canjs.com/doc/guides/contributing/project-organization.html)
+- [Reporting Bugs](https://canjs.com/doc/guides/contributing/bug-report.html)
+- [Suggesting Features](https://canjs.com/doc/guides/contributing/feature-suggestion.html)
+- [Finding Ways to Contribute](https://canjs.com/doc/guides/contributing/finding-ways-to-contribute.html)
+
+The rest of this guide has information that’s specific to this repository.
+
+## Developing Locally
+
+This section will walk you through setting up the [repository](https://github.com/canjs/can-validate-legacy) on your computer.
+
+### Signing up for GitHub
+
+If you don’t already have a GitHub account, you’ll need to [create a new one](https://help.github.com/articles/signing-up-for-a-new-github-account/).
+
+### Forking & cloning the repository
+
+A “fork” is a copy of a repository in your personal GitHub account. “Cloning” is the process of getting the repository’s source code on your computer.
+
+GitHub has a guide for [forking a repo](https://help.github.com/articles/fork-a-repo/). To fork can-validate-legacy, you can start by going to its [fork page](https://github.com/canjs/can-validate-legacy/fork).
+
+Next, you’ll want to clone the repo. [GitHub’s cloning guide](https://help.github.com/articles/cloning-a-repository/) explains how to do this on Linux, Mac, or Windows.
+
+GitHub’s guide will [instruct you](https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork) to clone it with a command like:
+
+```shell
+git clone https://github.com/YOUR-USERNAME/can-validate-legacy
+```
+
+Make sure you replace `YOUR-USERNAME` with your GitHub username.
+
+### Installing the dependencies
+
+After you’ve forked & cloned the repository, you’ll need to install the project’s dependencies.
+
+First, make sure you’ve [installed Node.js and npm](https://docs.npmjs.com/getting-started/installing-node).
+
+If you just cloned the repo from the command line, you’ll want to switch to the folder with your clone:
+
+```shell
+cd can-validate-legacy
+```
+
+Next, install the project’s dependencies with npm:
+
+```shell
+npm install
+```
+
+### Starting the development server
+
+Run the following to start a dev server:
+
+```shell
+npm run develop
+```
+
+### Running the tests
+
+You can manually run this repository’s tests in any browser by starting the dev server (see the section above) and visiting this page: http://localhost:8080/test/test.html
+
+Firefox is used to run the repository’s automated tests from the command line. If you don’t already have it, [download Firefox](https://www.mozilla.org/en-US/firefox/new/). Mozilla has guides for installing it on [Linux](https://support.mozilla.org/t5/Install-and-Update/Install-Firefox-on-Linux/ta-p/2516), [Mac](https://support.mozilla.org/t5/Install-and-Update/How-to-download-and-install-Firefox-on-Mac/ta-p/3453), and [Windows](https://support.mozilla.org/t5/Install-and-Update/How-to-download-and-install-Firefox-on-Windows/ta-p/2210).
+
+After Firefox is installed, you can run:
+
+```shell
+npm test
+```
+
+### Making a build
+
+Run the following command to create a build:
+
+```shell
+npm run build
+```
+
+This will create a `dist/` folder that contains the AMD, CommonJS, and global module versions of the project.
+

README.md

@@ -0,0 +1,28 @@
+# can-validate-legacy
+
+[![Join the chat at https://gitter.im/canjs/canjs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/canjs/canjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/canjs/can-validate-legacy/blob/master/LICENSE.md)
+[![npm version](https://badge.fury.io/js/can-validate-legacy.svg)](https://www.npmjs.com/package/can-validate-legacy)
+[![Travis build status](https://travis-ci.org/canjs/can-validate-legacy.svg?branch=master)](https://travis-ci.org/canjs/can-validate-legacy)
+[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/canjs/can-validate-legacy?branch=master&svg=true)](https://ci.appveyor.com/project/matthewp/can-validate-legacy)
+[![Coverage status](https://coveralls.io/repos/github/canjs/can-validate-legacy/badge.svg?branch=master)](https://coveralls.io/github/canjs/can-validate-legacy?branch=master)
+[![Greenkeeper badge](https://badges.greenkeeper.io/canjs/can-validate-legacy.svg)](https://greenkeeper.io/)
+
+Validation plugin for CanJS that provides an abstraction layer to your validation library of choice (Shim may be required).
+
+## Documentation
+
+Read the [can-validate-legacy API docs on CanJS.com](https://canjs.com/doc/can-validate-legacy.html).
+
+## Changelog
+
+See the [latest releases on GitHub](https://github.com/canjs/can-validate-legacy/releases).
+
+## Contributing
+
+The [contribution guide](https://github.com/canjs/can-validate-legacy/blob/master/CONTRIBUTING.md) has information on getting help, reporting bugs, developing locally, and more.
+
+## License
+
+[MIT](https://github.com/canjs/can-validate-legacy/blob/master/LICENSE.md)
+

package.json

@@ -14,8 +14,7 @@
     "release:patch": "npm version patch && npm run build && npm publish",
     "release:minor": "npm version minor && npm run build && npm publish",
     "release:major": "npm version major && npm run build && npm publish",
-    "build": "node build.js",
-    "document": "bit-docs"
+    "build": "node build.js"
   },
   "repository": {
     "type": "git",
@@ -71,23 +70,5 @@
   "dependencies": {
     "can-util": "^3.9.0-pre.4",
     "validate.js": "^0.11.1"
-  },
-  "bit-docs": {
-    "dependencies": {
-      "bit-docs-glob-finder": "^0.0.5",
-      "bit-docs-dev": "^0.0.3",
-      "bit-docs-js": "^0.0.3",
-      "bit-docs-generate-readme": "^0.0.8"
-    },
-    "glob": {
-      "pattern": "**/*.{js,md}",
-      "ignore": "node_modules/**/*"
-    },
-    "readme": {
-      "apis": [
-        "can-validate-legacy"
-      ]
-    },
-    "parent": "can-validate-legacy"
   }
 }