docs and fluff

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+## Contribution
+
+This is great that you'd like to contribute to this project. All change requests should go through the steps described below.
+
+## Pull Requests
+
+**Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or an obvious error.** Pull requests are the best way to propose changes to the specification.
+
+## Conventional commits
+
+Our repository follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
+
+Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification, simply ask maintainers to modify. You can also use this cheat sheet if you want:
+
+- `fix: ` prefix in the title indicates that PR is a bug fix and a PATCH release must be triggered.
+- `feat: ` prefix in the title indicates that PR is a feature and a MINOR release must be triggered.
+- `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger a release.
+- `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger a release.
+- `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger a release.
+- `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger a release.
+
+What about a MAJOR release? Just add `!` to the prefix, like `fix!: ` or `refactor!: `
+
+Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with the usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)
+
+## Example project
+
+You can create a Symlink in the example project by running the following command:
+
+```bash
+npm link ..
+```
+
+This will allow you to live-test your changes and it requires you have your own Pulumi backend.

README.md

@@ -1,5 +1,75 @@
 # pulumi-link-mobility-provider
 
-```bash
-npm link ..
-```
+A pulumi custom provider that allows you to create, update and delete destinations in Link Mobility's partner gate.
+
+## Installation
+
+To use from JavaScript or TypeScript in Node.js, install using either `npm`:
+
+```
+npm install @lego/pulumi-link-mobility-provider
+```
+
+or `yarn`:
+
+```
+yarn add @lego/pulumi-link-mobility-provider
+```
+
+## Usage
+
+```typescript
+const provider = new LinkMobilityPartnerGateDestinationProvider({
+  username: 'myGateUsername',
+  password: process.env.LINK_MOBILITY_PASSWORD!,
+  url: 'https://n-eu.linkmobility.io',
+  partner: 'myPartner',
+  platform: 'myPlatform',
+});
+
+new LinkMobilityPartnerGateDestination('link-mobility-foo-bar-destination', {
+  provider: provider,
+  partnerGateId: process.env.FOOBAR_PARTNER_GATE_ID!,
+  destination: {
+    url: 'https://foo.bar',
+    contentType: 'application/json',
+    // Username & password
+    username: 'fooBarUsername',
+    password: process.env.FOOBAR_PASSWORD!,
+    // Custom auth with API Key header
+    customParameters: {
+      'http.header1': `x-my-secret-header:${process.env.FOOBAR_HEADER_KEY}`,
+    },
+  },
+});
+```
+
+## Contribution
+
+This project welcomes contributions and suggestions.
+Would you like to contribute to the project? Learn how to contribute [here](CONTRIBUTING.md).
+
+## License
+
+[Modified Apache 2.0 (Section 6)](LICENSE)
+
+## Open Source Attribution
+
+### Project Dependencies
+
+- [@pulumi/pulumi](https://www.npmjs.com/package/@pulumi/pulumi): [Apache 2.0](https://github.com/pulumi/pulumi/blob/master/LICENSE)
+
+### Dev Dependencies
+
+- [@semantic-release/changelog](https://www.npmjs.com/package/@semantic-release/changelog) - [MIT](https://github.com/semantic-release/changelog/blob/master/LICENSE)
+- [@semantic-release/git](https://www.npmjs.com/package/@semantic-release/git) - [MIT](https://github.com/semantic-release/git/blob/master/LICENSE)
+- [@types/jest](https://www.npmjs.com/package/@types/jest): [MIT](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/LICENSE)
+- [@types/node](https://www.npmjs.com/package/@types/node): [MIT](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/LICENSE)
+- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin): [BSD-2-Clause](https://github.com/typescript-eslint/typescript-eslint/blob/main/LICENSE)
+- [@typescript-eslint/parser](https://www.npmjs.com/package): [BSD-2-Clause](https://github.com/typescript-eslint/typescript-eslint/blob/main/LICENSE)
+- [semantic-release](https://www.npmjs.com/package/semantic-release): [MIT](https://github.com/semantic-release/semantic-release/blob/master/LICENSE)
+- [eslint](https://www.npmjs.com/package/eslint): [MIT](https://github.com/eslint/eslint/blob/main/LICENSE)
+- [husky](https://github.com/typicode/husky): [MIT](https://github.com/typicode/husky?tab=MIT-1-ov-file#readme)
+- [jest](https://www.npmjs.com/package/jest): [MIT](https://github.com/facebook/jest/blob/main/LICENSE)
+- [ts-jest](https://www.npmjs.com/package/ts-jest): [MIT](https://github.com/kulshekhar/ts-jest/blob/main/LICENSE.md)
+- [typescript](https://www.npmjs.com/package/typescript): [Apache 2.0](https://github.com/microsoft/TypeScript/blob/main/LICENSE.txt)