docs(COMPT-59): add README, update peer deps, create v0.1.0 changeset

[y-aithnini]

Summary

• What does this PR change?

Why

• Why is this change needed?

Checklist

• Added/updated tests (if behavior changed)
• npm run lint passes
• npm run typecheck passes
• npm test passes
• npm run build passes
• Added a changeset (npx changeset) if this affects consumers

Notes

• Anything reviewers should pay attention to?

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull request overview

Updates CacheKit’s consumer-facing documentation and release metadata, aiming to prep an initial publish by documenting the API, adjusting peer dependencies, and adding a v0.1.0 changeset.

Changes:

• Rewrote/expanded README.md with installation + usage docs for CacheModule, CacheService, and caching decorators.
• Updated package.json peer dependency strategy (moving ioredis to optional peer and clearing dependencies).
• Added a Changesets entry for the intended v0.1.0 release.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
README.md	Adds CacheKit usage docs, but currently still includes leftover template sections after License.
package.json	Adjusts peer deps and empties dependencies (currently conflicts with runtime imports/exports).
.changeset/compt-59-v0-1-0.md	Adds initial-release changeset, but versioning claims don’t match current package version.

Comments suppressed due to low confidence (1)

README.md:296

• README still contains leftover module-template content after the CacheKit docs (starting right after the License section). The sections about defining Example DTOs, exporting ExampleKitModule, scripts, and release workflow reference class-validator / ExampleKitModule and will confuse consumers of @ciscode/cachekit (and also conflicts with the new peer-deps story). Remove these template sections or fully rewrite them to match CacheKit’s actual public API and dependencies.

## 📄 License

MIT © [CisCode](https://github.com/CISCODE-MA)

### 3. Define DTOs

```typescript
// src/dto/create-example.dto.ts
import { IsString, IsNotEmpty } from "class-validator";

export class CreateExampleDto {
  @IsString()
  @IsNotEmpty()
  name: string;
}

4. Export Public API

// src/index.ts
export { ExampleKitModule } from "./example-kit.module";
export { ExampleService } from "./services/example.service";
export { CreateExampleDto } from "./dto/create-example.dto";

</details>