Update README.md
Added instructions about how to generate a GitHub OAuth token.
@@ -297,7 +297,8 @@ List<Refactoring> refactorings = modelDiff.getRefactorings();
```
## With all information fetched directly from GitHub
-**To use this API, please provide a valid OAuth token in the `github-oauth.properties` file.**
+To use this API, please provide a valid OAuth token in the `github-oauth.properties` file.
+You can generate an OAuth token in GitHub `Settings` -> `Developer settings` -> `Personal access tokens`.
If you don't want to clone locally the repository, you can use the following code snippet:
@@ -437,6 +438,7 @@ If you don't want to clone locally the repository, run:
> ./RefactoringMiner -gc https://github.com/danilofes/refactoring-toy-example.git 36287f7c3b09eff78395267a3ac0d7da067863fd 10
For the `-gc` and `-gp` options you must provide a valid OAuth token in the `github-oauth.properties` file stored in the `bin` folder.
+You can generate an OAuth token in GitHub `Settings` -> `Developer settings` -> `Personal access tokens`.
In both cases, you will get the output in JSON format:
