diff --git a/README.md b/README.md index c3e42d1..493b218 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,15 @@ -# billa_bear +

+ +

-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: +

+

BillaBear Javascript SDK

+

-- 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 @@ -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']; diff --git a/git_push.sh b/git_push.sh index 3dbbd4a..f03535e 100644 --- a/git_push.sh +++ b/git_push.sh @@ -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 @@ -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 diff --git a/package.json b/package.json index 3ba943a..db1b227 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "billa_bear", + "name": "billabear", "version": "1.0.0", "description": "The_REST_API_provided_by_BillaBear", "license": "FSL",