Skip to content
This repository has been archived by the owner on Nov 26, 2022. It is now read-only.

Commit

Permalink
docs: rename license, readme and code of conduct (#101)
Browse files Browse the repository at this point in the history
* docs: rename license, readme and code of conduct

Change file names to uppercase.

* chore: rename license, readme and code of conduct

* add changeset
  • Loading branch information
boywithkeyboard committed Jul 23, 2022
1 parent 0d4daf4 commit 4931608
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 65 deletions.
7 changes: 7 additions & 0 deletions .changeset/brown-hotels-fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"cachu": patch
---

docs: rename license, readme and code of conduct

Change file names to uppercase.
File renamed without changes.
2 changes: 1 addition & 1 deletion license → LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<div align='center'>
<h1>cachu</h1>
</br></br>
</div>

> **Notice**
Need an introduction to v6? [Here](https://gist.github.com/unvented/dab8d3e987cfdd79f68e715d29c1ee17) you go!

## Setup

```bash
# Get the latest release.
npm i cachu

# Try the latest commit.
npm i cachu@dev
```

## Usage

### Deno

```typescript
import { useCache } from 'https://deno.land/x/cachu@v6.0.0/mod.ts'

const cache = await useCache()
```

### Node.js

```js
import { useCache } from 'cachu'

const cache = await useCache()

// Add a new entry.
await cache.add('one', 'Hello World')

const entry = await cache.get('one') // 'Hello World'
```

## API

* #### Configuration

* [`maxAge`](/guide/config/maxAge.md) to set the **maximum age** for each record in the cache
* [`maxAmount`](/guide/config/maxAmount.md) to set the **maximum size** for the cache

* #### Features

* [`add()`](/guide/features/set.md)
* [`addMany()`](/guide/features/setMany.md)
* [`get()`](/guide/features/get.md)
* [`getMany()`](/guide/features/getMany.md)
* [`update()`](/guide/features/update.md)
* [`updateMany()`](/guide/features/updateMany.md)
* [`remove()`](/guide/features/delete.md)
* [`removeMany()`](/guide/features/deleteMany.md)
* [`has()`](/guide/features/has.md)
* [`size()`](/guide/features/size.md)
* [`keys()`](/guide/features/keys.md)
* [`values()`](/guide/features/values.md)
* [`clear()`](/guide/features/clear.md)
64 changes: 0 additions & 64 deletions readme.md

This file was deleted.

0 comments on commit 4931608

Please sign in to comment.