Example use for documentation

[whyboris]

I'm loving how useful and slim this package is ❤️

I thought minor documentation would be helpful 🙇

[tad-lispy]

Hey! Thank you very much. It's a change in a right direction. I'd like to suggest few improvements to your improvements... if I may say so 😉

Also, just like in #12, please update the changelog and take credit for your work.

It's alright if you have no time for this. If that's the case just let me know and I'll take care of it.

[tad-lispy]

I think it would make sense to move it below the example you provided.

[tad-lispy]

It seems to me that there is nothing specific to Angular in this example. Am I missing something?

[tad-lispy]

How about:

Install

npm install damerau-levenshtein

Use with ES6 modules

import * as levenshtien from 'damerau-levenshtein';

// ...

const lev = levenshtien('hello world', 'Hello World!');
// { steps: 4, relative: 0.3076923076923077, similarity: 0.6923076923076923 }

Use with TypeScript

interface LevenshteinResponse {
  steps: number;
  relative: number;
  similarity: number;
}

[tad-lispy]

Would you please provide more complete example? How would I use this interface?

[whyboris]

Thank you for detailed feedback. What do you think of this? 😄

[tad-lispy]

Good to go. Thanks!

[tad-lispy]

Hey, since you are using it with TypeScript, would you mind adding type annotations. If you do please make a separate PR and use the index.d.ts file. I'm mot using TypeScript so I'd prefer to stay with vanilla JS for the main module.

Of course only if you have time. You helped a lot already.

[whyboris]

This will be a great learning experience -- I've been meaning to learn how all the .d.ts files work 😅

I'll look into it 👍

[tad-lispy]

I've published your stuff: https://www.npmjs.com/package/damerau-levenshtein/v/1.0.5

Thank you very much. I'm looking forward for the TS PR.

[whyboris]

Thank you for the suggestion, hope this works: #14