UNPKG

1.22 kBMarkdownView Raw
1![Atlasboard](https://bitbucket.org/atlassian/atlasboard/raw/master/screenshots/wallboard8x6.png)
2
3##Build status##
4
5[![Build Status](https://drone.io/bitbucket.org/atlassian/atlasboard/status.png)](https://drone.io/bitbucket.org/atlassian/atlasboard/latest)
6
7##Installation##
8
9`npm install -g atlasboard`
10
11
12##Creating your first wallboard##
13
14After installing Atlasboard as a global module, you may want to do this:
15
16`atlasboard new mywallboard`
17
18
19to generate your wallboard.
20
21
22##Importing your first package##
23
24You probably want to reuse the dashboards, widgets and jobs that people have already created.
25
26The [Atlassian package](https://bitbucket.org/atlassian/atlasboard-atlassian-package) is a good start. Atlasboard packages are installed as submodules. You need to initialise a git repository first. Just type:
27
28 git init
29 git submodule add https://bitbucket.org/atlassian/atlasboard-atlassian-package packages/atlassian
30
31Don't forget to setup your credentials (globalAuth.json file)!
32
33## Documentation
34
35[Check out the wiki](https://bitbucket.org/atlassian/atlasboard/wiki/Home)
36
37## More information
38
39Check out the [Atlasboard website](http://atlasboard.bitbucket.org).