Browse Source

Add README

This patch adds a readme introducing js-openstack-lib and it's purpose.
A simple example in ES6 was added.

Change-Id: I8c6cedd13b6bcd965b7c88c73c8499f53882c331
Corentin Ardeois 2 years ago
parent
commit
9903d95abd
1 changed files with 58 additions and 0 deletions
  1. 58
    0
      README.rst

+ 58
- 0
README.rst View File

@@ -0,0 +1,58 @@
1
+JS-OpenStack-lib
2
+================
3
+
4
+JS-OpenStack-lib is a Javascript library for interacting with OpenStack clouds. The project aims to provide a constistent and complete set of interactions with OpenStack's many services, along with documentations, examples, and tools.
5
+This library is compatible with both browser and server side Javascript.
6
+
7
+Example
8
+-------
9
+
10
+The following example simply connects to an OpenStack cloud and list flavors in the Compute service:
11
+
12
+::
13
+
14
+   import OpenStack from 'js-openstack-lib';
15
+
16
+   // Initialize cloud
17
+   // cloudConfig is a JSON object corresponding to clouds.yaml
18
+   // (It is your responsibility to load and parse it)
19
+   const openStack = new OpenStack({
20
+     region_name: 'Region1',
21
+     auth: {
22
+       username: 'user',
23
+       password: 'pass',
24
+       project_name: 'js-openstack-lib',
25
+       auth_url: 'http://192.168.99.99/'
26
+     }
27
+   });
28
+   // List all flavors
29
+   openStack.networkList()
30
+     .then((networks) => {
31
+       console.log(networks);
32
+     });
33
+
34
+Documentation
35
+-------------
36
+
37
+Coming soon
38
+
39
+Contributing
40
+------------
41
+
42
+If you're interested in contributing, the following will help you get started:
43
+
44
+:Bug Tracker: https://storyboard.openstack.org/#!/project/844
45
+:Code Hosting: https://git.openstack.org/cgit/openstack/js-openstack-lib
46
+:Code Review:
47
+    https://review.openstack.org/#/q/status:open+project:openstack/js-openstack-lib,n,z
48
+
49
+    Please read `Developer's Guide <http://docs.openstack.org/infra/manual/developers.html>`_ before sending your first patch for review
50
+
51
+
52
+
53
+License
54
+-------
55
+
56
+Apache 2.0
57
+
58
+

Loading…
Cancel
Save