# tinyPicture

**Repository Path**: yangdan1028/tiny-picture

## Basic Information

- **Project Name**: tinyPicture
- **Description**: 自动压缩项目中文件的库
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2022-08-02
- **Last Updated**: 2022-12-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# tinyPicture

#### introduce

Automatically compress the library of pictures in the project.


#### Installation tutorial

1. npm i tiny_yd_kiko.
2. Add the configuration file "tinyYd.config.ts" to the project.
3. Type in the configuration file.

"projectImageSaveDir" is the path to store pictures.

"Key" is the key required by the image compression library, which can be obtained from the official website of the library [https://tinypng.com/developers](https://tinypng.com/developers).

```
export default {
  configs: [
    {
      projectImageSaveDir: 'The directory where your pictures are stored',//ex:./src/images
    },
  ],
  key: 'your tiny apiKey'
}

```



#### instructions

1. Write in the script of package.json.

```
  "scripts": {
    "compressPic": "tinyYd"
  }
```

2. Execute the command npm run compresspic on the terminal to compress the pictures in the project.

3. Let's have a try.