Constructor
new ReadmeAppraisal(serviceEndpointUrlopt)
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
serviceEndpointUrl |
string
|
<optional> |
http://readme-score-api.herokuapp.com/score.json?url=&human_breakdown=false&force=false |
The URL of the readme-score-api service you want to consume. |
Methods
for(url, apiEndpointopt) → {Promise.<AppraisalData>}
Evalutate the root-level README in a repository (if present).
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
url |
string
|
A URL or repository slug. |
||
apiEndpoint |
URL
|
<optional> |
http://readme-score-api.herokuapp.com/score.json?url= |
The API endpoint. |
Example
const ReadmeAppraisal = require('./readme-appraisal')
// Parameters: url|slug|string<html>
const readmeAppraisal = new ReadmeAppraisal()
const result = await readmeAppraisal.for('commonality/readme-inspector')