Merge pull request #13 from rafaelmartinelli/doc-update

Update docs and workflows after registration.
rafaelmartinelli · Jun 7, 2022 · 86501f8 · 86501f8
2 parents cfdc108 + f9dd27b
commit 86501f8
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -62,4 +62,4 @@ jobs:
       - run: julia --project=docs docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          DOCUMENTER_KEY: ${{ secrets.SSH_KEY }}
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
@@ -12,4 +12,4 @@ jobs:
       - uses: JuliaRegistries/TagBot@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          ssh: ${{ secrets.SSH_KEY }}
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # FacilityLocationProblems.jl
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://rafaelmartinelli.github.io/FacilityLocationProblems.jl/stable)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://rafaelmartinelli.github.io/FacilityLocationProblems.jl/dev)[![Build Status](https://github.com/rafaelmartinelli/FacilityLocationProblems.jl/workflows/CI/badge.svg)](https://github.com/rafaelmartinelli/FacilityLocationProblems.jl/actions)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://rafaelmartinelli.github.io/FacilityLocationProblems.jl/dev)
+[![Build Status](https://github.com/rafaelmartinelli/FacilityLocationProblems.jl/workflows/CI/badge.svg)](https://github.com/rafaelmartinelli/FacilityLocationProblems.jl/actions)
 [![Coverage](https://codecov.io/gh/rafaelmartinelli/FacilityLocationProblems.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/rafaelmartinelli/FacilityLocationProblems.jl)
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 
@@ -47,12 +48,12 @@ data = loadFacilityLocationProblem("/path/to/your/CFLP/instance.txt", optional_f
 
 ## Installation
 
-FacilityLocationProblems is *not* yet a registered Julia Package.
+FacilityLocationProblems is a registered Julia Package (yay!).
 You can install FacilityLocationProblems through the Julia package manager.
 Open Julia's interactive session (REPL) and type:
 
 ```julia
-] add https://github.com/rafaelmartinelli/FacilityLocationProblems.jl
+] add FacilityLocationProblems
 ```
 
 ## Related links
@@ -62,7 +63,7 @@ Open Julia's interactive session (REPL) and type:
 
 ## Other packages
 
-- [KnapsackLib.jl](https://github.com/rafaelmartinelli/KnapsackLib.jl): Knapsack algorithms in Julia
+- [KnapsackLib.jl](https://github.com/rafaelmartinelli/Knapsacks.jl): Knapsack algorithms in Julia
 - [GAPLib.jl](https://github.com/rafaelmartinelli/GAPLib.jl): Generalized Assignment Problem Lib
 - [BPPLib.jl](https://github.com/rafaelmartinelli/BPPLib.jl): Bin Packing and Cutting Stock Lib
 - [CARPData.jl](https://github.com/rafaelmartinelli/CARPData.jl): Capacitated Arc Routing Problem Lib
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -46,12 +46,12 @@ data = loadFacilityLocationProblem("/path/to/your/CFLP/instance.txt", optional_f
 
 ## Installation
 
-FacilityLocationProblems is *not* yet a registered Julia Package.
+FacilityLocationProblems is a registered Julia Package (yay!).
 You can install FacilityLocationProblems through the Julia package manager.
 Open Julia's interactive session (REPL) and type:
 
 ```julia
-] add https://github.com/rafaelmartinelli/FacilityLocationProblems.jl
+] add FacilityLocationProblems
 ```
 
 ```@index