diff --git a/docs/README.md b/docs/README.md index aad58d93e..e8863f520 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,60 +1,5 @@ -# Welcome to the Atom API Documentation +# Welcome to the Atom Docs ![Atom](https://cloud.githubusercontent.com/assets/72919/2874231/3af1db48-d3dd-11e3-98dc-6066f8bc766f.png) -## FAQ - -### Where do I start? - -Check out [EditorView][EditorView] and [Editor][Editor] classes for a good -overview of the main editor API. - -### How do I access these classes? - -Check out the [Atom][Atom] class docs to see what globals are available and -what they provide. - -You can also require many of these classes in your package via: - -```coffee -{EditorView} = require 'atom' -``` - -The classes available from `require 'atom'` are: - * [BufferedProcess][BufferedProcess] - * [BufferedNodeProcess][BufferedNodeProcess] - * [EditorView][EditorView] - * [Git][Git] - * [Point][Point] - * [Range][Range] - * [ScrollView][ScrollView] - * [SelectListView][SelectListView] - * [View][View] - * [WorkspaceView][WorkspaceView] - * [Workspace][Workspace] - -### How do I create a package? - -You probably want to read the [creating a package][creating-a-package] -doc first and come back here when you are done. - -### Where are the node docs? - -Atom ships with node 0.11.10 and the comprehensive node API docs are available -[here][node-docs]. - -[Atom]: ../classes/Atom.html -[BufferedProcess]: ../classes/BufferedProcess.html -[BufferedNodeProcess]: ../classes/BufferedNodeProcess.html -[Editor]: ../classes/Editor.html -[EditorView]: ../classes/EditorView.html -[Git]: ../classes/Git.html -[Point]: ../classes/Point.html -[Range]: ../classes/Range.html -[ScrollView]: ../classes/ScrollView.html -[SelectListView]: ../classes/SelectListView.html -[View]: ../classes/View.html -[WorkspaceView]: ../classes/WorkspaceView.html -[Workspace]: ../classes/Workspace.html -[creating-a-package]: https://atom.io/docs/latest/creating-a-package -[node-docs]: http://nodejs.org/docs/v0.11.10/api +TODO: Write when docs move to a dedicated repo.