Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Remove beta notice in api guide #395

Merged
merged 1 commit into from
May 14, 2020
Merged

docs: Remove beta notice in api guide #395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/manual/advanced/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
# Guide: Using the API

> Learn how to use the atscm API to e.g. run server serverscripts in your node application.
> **The atscm API is currently in beta.**
> **Available since atscm v1.0.0.** Use `atscm update` to use the latest version

## Installation

First of all, make sure your project has atscm installed: Take a look at your _package.json_ file and make sure, atscm is present in the _dependencies_ or (depending on your use case) _devDependencies_ section. Otherwise, **install atscm if necessary**:

```bash
# If you need atscm as a runtime-dependency
npm install --save atscm@beta
npm install --save atscm

# If you need atscm as a development dependency
npm install --save-dev atscm@beta
# If you need atscm as a development dependency (most likely)
npm install --save-dev atscm
```

<!-- FIXME: Remove once 1.0.0 is realease -->

> Once atscm v1.0.0 is released, you can omit the `@beta`.

## Configuration

Similar to regular atscm projects, you need an _Atviseproject_ file that contains atscm's configuration. A minimal example may look like this:
Expand Down