Analyze Github Readme

An algorithm for analyzing GitHub readmes and making recommendations for improving it.

Algorithmia Platform License · Internet Access

Run an Example

{
  "score": {
    "pre": 4,
    "header": 7,
    "length": 6,
    "paragraph": 5,
    "img": 5
  },
  "recommendation": {
    "pre": [
      {
        "operation": "decrease",
        "value": 1
      }
    ],
    "header": [
      {
        "operation": "insert",
        "value": "features"
      },
      {
        "operation": "insert",
        "value": "overview"
      },
      {
        "operation": "insert",
        "value": "code"
      },
      {
        "operation": "delete",
        "value": "installation"
      },
      {
        "operation": "insert",
        "value": "developer"
      },
      {
        "operation": "insert",
        "value": "authorities"
      },
      {
        "operation": "insert",
        "value": "supported"
      },
      {
        "operation": "insert",
        "value": "configurations"
      },
      {
        "operation": "insert",
        "value": "note"
      },
      {
        "operation": "insert",
        "value": "start"
      }
    ],
    "length": [
      {
        "operation": "decrease",
        "value": 3426
      }
    ],
    "paragraph": [
      {
        "operation": "insert",
        "value": "coded"
      },
      {
        "operation": "insert",
        "value": "queries"
      },
      {
        "operation": "insert",
        "value": "prefixed"
      },
      {
        "operation": "insert",
        "value": "implementable"
      },
      {
        "operation": "insert",
        "value": "profiling"
      },
      {
        "operation": "insert",
        "value": "depend"
      },
      {
        "operation": "insert",
        "value": "sending"
      },
      {
        "operation": "insert",
        "value": "easiest"
      },
      {
        "operation": "insert",
        "value": "programing"
      },
      {
        "operation": "insert",
        "value": "merchantability"
      }
    ],
    "img": []
  }
}

Install & Use

Use

curl -X POST -d '{
  "repo": "https://github.com/algorithmiaio/algorithmia-python"
}' -H 'Content-Type: application/json' -H 'Authorization: Simple YOUR_API_KEY' https://api.algorithmia.com/v1/algo/nlp/AnalyzeGithubReadme/0.1.15