@devben/searchy v1.0.2

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install @devben/searchy

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Install NPM packages

   npm install @devben/searchy

2. Import the package

   import searchy from '@devben/searchy';

3. Use the package

   const array = [{
      "id": "6183c8dccfc4a090e9174af0",
      "firstName":"Molina Mcknight",
      "email": "molinamcknight@medalert.com",
      "lastName":"Digiprint",
      "state": 'inactive'
    },
    {
      "id": "6183c8dcf34190a21d291bfa",
      "firstName":"Beverly Walls",
      "email": "beverlywalls@digiprint.com",
      "lastName":"Vendblend",
      "state": 'active'
    },
    {
      "id": "6183c8dc087471c31f25b976",
      "firstName":"Hawkins Richardson",
      "email": "hawkinsrichardson@vendblend.com",
      "lastName":"Arctiq",
      "state": 'active'
    }
   ];
   
   const search = new Searchy;
   
   let results = search.find('beverly Digiprint', array);
   
   return ---> [{
      "id": "6183c8dcf34190a21d291bfa",
      "firstName":"Beverly Walls",
      "email": "beverlywalls@digiprint.com",
      "lastName":"Vendblend",
      "state": 'active'
    }];

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Roadmap

• Add Changelog
• Add back to top links
• [] Add Additional Templates w/ Examples
• [] Add "components" document to easily copy & paste sections of the readme
• [] Multi-language Support
  • [] Chinese
  • [] Spanish

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Website Link: https://www.devben.app

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License