s3encode/README.md

Encode url symbols to be s3 compatible

# S3Encode

Encode url symbols to be s3 compatible

## Install

install using **yarn** or **npm**

**yarn**

```bash
$ yarn add s3encode
```

**npm**

```bash
$ npm install s3encode
```

## Use

*typescript*
```typescript
import S3Encode from "s3encode"
const encodedString =  S3Encode("/This is my url with a symbol ?")
```

*javascript*
```typescript
const S3Encode = require("s3encode").default
const encodedString =  S3Encode("/This is my url with a symbol ?")
```

## Code of conduct

Code of conduct can be found at [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)

## Contributing

Make sure to read **Contribution Guidelines** at [CONTRIBUTING.md](CONTRIBUTING.md) before contributing.

## License & Copyright

Copyright (C) 2020 Aniket Prajapati

Licensed under the [MIT LICENSE](LICENSE)

## Contributors
 + [Aniket Prajapati](https://github.com/aniketfuryrocks) @ prajapati.ani306@gmail.com , [eAdded](http://www.eadded.com)