Add citation (open-mmlab#151)

* Add citation * fix typo
RunningLeon · Oct 27, 2021 · c8b78f6 · c8b78f6
1 parent 6c420dc
commit c8b78f6
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,8 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "OpenMMLab's Model deployment toolbox"
+authors:
+  - name: "MMDeploy Contributors"
+date-released: 2021-12-27
+url: "https://github.com/open-mmlab/mmdeploy"
+license: Apache-2.0
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ a part of the [OpenMMLab](https://openmmlab.com/) project.
 
 - **Multiple inference engine support**
 
-  Models can be exported and inferenced with different backends. Such as ONNX Runtime, TensorRT, etc.
+  Models can be exported and run in different backends. Such as ONNX Runtime, TensorRT, etc.
 
 - **Model rewrite**
 
@@ -50,6 +50,19 @@ Please read [how_to_convert_model.md](docs/tutorials/how_to_convert_model.md) fo
 
 Please refer to [FAQ](docs/faq.md) for frequently asked questions.
 
+## Citation
+
+If you find this project useful in your research, please consider cite:
+
+```BibTeX
+@misc{=mmdeploy,
+    title={OpenMMLab's Model deployment toolbox.},
+    author={MMDeploy Contributors},
+    howpublished = {\url{https://github.com/open-mmlab/mmdeploy}},
+    year={2021}
+}
+```
+
 ## Contributing
 
 We appreciate all contributions to improve MMDeploy. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.

diff --git a/mmdeploy/version.py b/mmdeploy/version.py
@@ -1,4 +1,4 @@
-# Copyright (c) Open-MMLab. All rights reserved.
+# Copyright (c) OpenMMLab. All rights reserved.
 
 __version__ = '0.1.0'
 short_version = __version__