From 351c1d3b4f337f09f97efc09225d28020f0868e5 Mon Sep 17 00:00:00 2001
From: Sven SAULEAU <xtuc@users.noreply.github.com>
Date: Mon, 5 Dec 2016 19:36:31 +0100
Subject: [PATCH] Update README [skip ci] (#4938)

---
 packages/babel-core/README.md | 72 ++++++++++++++++++++++++++++-------
 1 file changed, 58 insertions(+), 14 deletions(-)

diff --git a/packages/babel-core/README.md b/packages/babel-core/README.md
index 6b1f66395b..7bf80c9184 100644
--- a/packages/babel-core/README.md
+++ b/packages/babel-core/README.md
@@ -2,23 +2,67 @@
 
 > Babel compiler core.
 
-## Install
-
-```
-npm install --save-dev babel-core
+```javascript
+var babel = require("babel-core");
+import { transform } from 'babel-core';
+import * as babel from 'babel-core';
 ```
 
-## Usage
+## babel.transform(code: string, [options?](/docs/usage/options): Object)
+
+Transforms the passed in `code`. Returning an object with the generated code,
+source map, and AST.
 
 ```js
-import * as babel from 'babel-core';
-
-const code = `class Example {}`;
-const result = babel.transform(code, { /* options */ });
-
-result.code; // Generated code
-result.map; // Sourcemap
-result.ast; // AST
+babel.transform(code, options) // => { code, map, ast }
 ```
 
-For more in depth documentation see: http://babeljs.io/docs/usage/api/
+**Example**
+
+```js
+var result = babel.transform("code();", options);
+result.code;
+result.map;
+result.ast;
+```
+
+## babel.transformFile(filename: string, [options?](/docs/usage/options): Object, callback: Function)
+
+Asynchronously transforms the entire contents of a file.
+
+```js
+babel.transformFile(filename, options, callback)
+```
+
+**Example**
+
+```js
+babel.transformFile("filename.js", options, function (err, result) {
+  result; // => { code, map, ast }
+});
+```
+
+## babel.transformFileSync(filename: string, [options?](/docs/usage/options): Object)
+
+Synchronous version of `babel.transformFile`. Returns the transformed contents of
+the `filename`.
+
+```js
+babel.transformFileSync(filename, options) // => { code, map, ast }
+```
+
+**Example**
+
+```js
+babel.transformFileSync("filename.js", options).code;
+```
+
+## babel.transformFromAst(ast: Object, code?: string, [options?](/docs/usage/options): Object)
+
+Given, an [AST](https://astexplorer.net/), transform it.
+
+```js
+const code = "if (true) return;";
+const ast = babylon.parse(code, { allowReturnOutsideFunction: true });
+const { code, map, ast } = babel.transformFromAst(ast, code, options);
+```