<commit_before># GitHub API Cache #

**GitHub API Chache** provides cached result populated from [GitHub][gh] API requests. As a default, [GitHub][gh] only allows 60 API calls per hour for anonymous users. For authenticated users, [GitHub][gh] only allows 5000 API calls per hour. Both are not enough for certain cases. As this stores responses populated from API requests into a web server's cache memory, it minimises the number of API calls so that API limit can be avoided.


## Getting Started ##

**GitHub API Chache** supports three different authentication types &ndash; `Anonymous`, `Basic` and `AuthenticationKey`. Even though it supports the `Basic` authentication type, this is strongly **NOT** recommended to use as your [GitHub][gh] username and password is exposed on the Internet.


### Anonymouse Type ###

You can simply send cURL request on a command prompt like:

```shell
$ curl -i https://hook.aliencube.local/api/ref/{user}/{repo}/{branch}
```

If you are using [jQuery][jquery], this can be possible:

```javascript
$.ajax({
    type: "GET",
    url: "https://hook.aliencube.local/api/ref/{user}/{repo}/{branch}",
    dataType: "json"
})
.done(function(data) {
    // DO STUFF
});
```


### AuthenticationKey Type ###

You can simply send cURL request on a command prompt like:

```shell
$ curl -H "Authorization: token OAUTH-TOKEN" https://hook.aliencube.local/api/ref/{user}/{repo}/{branch}
```

If you are using [jQuery][jquery], this can be possible:

```javascript
$.ajax({
    type: "GET",
    url: "https://hook.aliencube.local/api/ref/{user}/{repo}/{branch}",
    dataType: "json",
    headers: { "Authorization": "token OAUTH-TOKEN" }
})
.done(function(data) {
    // DO STUFF
});
```


## Configurations ##

In order to change some configurations, `Web.config` needs to be touched.
<commit_msg>Updated README.md.<commit_after># GitHub API Cache #

**GitHub API Chache** provides cached result populated from [GitHub][gh] API requests. As a default, [GitHub][gh] only allows 60 API calls per hour for anonymous users. For authenticated users, [GitHub][gh] only allows 5000 API calls per hour. Both are not enough for certain cases. As this stores responses populated from API requests into a web server's cache memory, it minimises the number of API calls so that API limit can be avoided.


## Getting Started ##

**GitHub API Chache** supports three different authentication types &ndash; `Anonymous`, `Basic` and `AuthenticationKey`. Even though it supports the `Basic` authentication type, this is strongly **NOT** recommended to use as your [GitHub][gh] username and password is exposed on the Internet.


### Anonymouse Type ###

You can simply send cURL request on a command prompt like:

```shell
$ curl -i https://githubapicache.apphb.com/api/ref/{user}/{repo}/{branch}
```

If you are using [jQuery][jquery], this can be possible:

```javascript
$.ajax({
    type: "GET",
    url: "https://githubapicache.apphb.com/api/ref/{user}/{repo}/{branch}",
    dataType: "json"
})
.done(function(data) {
    // DO STUFF
});
```


### AuthenticationKey Type ###

You can simply send cURL request on a command prompt like:

```shell
$ curl -H "Authorization: token OAUTH-TOKEN" https://githubapicache.apphb.com/api/ref/{user}/{repo}/{branch}
```

If you are using [jQuery][jquery], this can be possible:

```javascript
$.ajax({
    type: "GET",
    url: "https://githubapicache.apphb.com/api/ref/{user}/{repo}/{branch}",
    dataType: "json",
    headers: { "Authorization": "token OAUTH-TOKEN" }
})
.done(function(data) {
    // DO STUFF
});
```


## Configurations ##

In order to change some configurations, `Web.config` needs to be touched.

{'fraction_non_alphanumeric': 0.13924394887136252, 'fraction_numerical': 0.003263530051672559, 'mean_word_length': 4.2844827586206895, 'pattern_counts': {'":': 2, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2904823', 'n_tokens_mistral': 1133, 'n_tokens_neox': 1084, 'n_words': 419}