Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
that-guy-iain committed Jul 21, 2024
1 parent dbf2a53 commit 484f994
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 63 deletions.
69 changes: 9 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,15 @@
# billa_bear
<p align="center">
<img width="450px" src="https://ha-static-data.s3.eu-central-1.amazonaws.com/github-readme-logo.png">
</p>

BillaBear - JavaScript client for billa_bear
The REST API provided by BillaBear
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
<p align="center">
<h1 style="text-align: center">BillaBear Javascript SDK</h1>
</p>

- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
For more information, please visit [http://www.billabear.com/support](http://www.billabear.com/support)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install billa_bear --save
```

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/billabear/go-sdk
then install it via:

```shell
npm install billabear/go-sdk --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):
## Installation & Usage

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
npm install billabear --save
```

## Getting Started
Expand All @@ -71,6 +19,7 @@ Please follow the [installation](#installation) instruction and execute the foll
```javascript
var BillaBear = require('billa_bear');
var defaultClient = BillaBear.ApiClient.instance;
defaultClient.basePath = 'YOUR API URL'

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
Expand Down
4 changes: 2 additions & 2 deletions git_push.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ if [ "$git_user_id" = "" ]; then
fi

if [ "$git_repo_id" = "" ]; then
git_repo_id="go-sdk"
git_repo_id="javascript-sdk"
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
fi

Expand All @@ -28,7 +28,7 @@ git init
# Adds the files in the local repository and stages them for commit.
git add .

# Commits the tracked changes and prepares them to be pushed to a remote repository.
# Commits the tracked changes and prepares them to be pushed to a remote repository.
git commit -m "$release_note"

# Sets the new remote
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "billa_bear",
"name": "billabear",
"version": "1.0.0",
"description": "The_REST_API_provided_by_BillaBear",
"license": "FSL",
Expand Down

0 comments on commit 484f994

Please sign in to comment.