Add citation (#121)

* add CITATION.bib * update LICENSE * update Project.toml * update README
JuliaReinforcementLearning · Jan 12, 2021 · dedfa11 · dedfa11
1 parent 60a10f1
commit dedfa11
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/CITATION.bib b/CITATION.bib
@@ -0,0 +1,6 @@
+@misc{Bhatia2020GridWorlds,
+  author={Bhatia, Siddharth and Tian, Jun and contributors},
+  title={GridWorlds.jl: A package for creating grid worlds for reinforcement learning in Julia},
+  year=2020,
+  url={https://github.com/JuliaReinforcementLearning/GridWorlds.jl}
+}
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Sriram
+Copyright (c) 2020 Siddharth Bhatia <[email protected]>, Jun Tian <[email protected]>, and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "GridWorlds"
 uuid = "e15a9946-cd7f-4d03-83e2-6c30bacb0043"
-authors = ["Siddharth Bhatia <[email protected]> and contributors"]
+authors = ["Siddharth Bhatia <[email protected]>", "Jun Tian <[email protected]>", "contributors"]
 version = "0.3.0"
 
 [deps]

diff --git a/README.md b/README.md
@@ -1,6 +1,9 @@
 # GridWorlds
 
-This package aims to provide grid world environments for reinforcement learning research in Julia. The focus of this package is on being **lightweight** and **efficient**. This package is inspired by [gym-minigrid](https://github.com/maximecb/gym-minigrid).
+A package for creating grid world environments for reinforcement learning in Julia.
+The focus of this package is on being **lightweight** and **efficient**.
+This package is inspired by [gym-minigrid](https://github.com/maximecb/gym-minigrid).
+In order to cite this package, please refer to the file `CITATION.bib`. Starring the repository on GitHub is also appreciated.
 
 ## Table of contents: