chore: improve the UI & content in README by lionztt · Pull Request #2227

chore: improve the UI & content in README by lionztt · Pull Request #2227 · apache/hugegraph

Improve HugeGraph Readme

Change logo img to no-background, which can use in dark theme; and change logo img size to narrow size, which take up less space.
Put the introduction at the top of the readme to briefly explain hugegraph
Fix hugegraph codecov link and img link to correct
Add stars img after downloads count
Add icons for all title
Add contribution img to thanks all hugegraph contributors
Add Contributor Over Time and Stargazers Over Time to explain the product contribution and star process

README.md Outdated Show resolved Hide resolved

Comment on lines +70 to +76

		## ⏰ Contributor Over Time

		[![Stargazers Over Time](https://contributor-overtime-api.git-contributor.com/contributors-svg?chart=contributorOverTime&repo=apache/incubator-hugegraph)](https://git-contributor.com?chart=contributorOverTime&repo=apache/incubator-hugegraph)

		## 👍 Stargazers Over Time

		![Stargazers over time](https://api.star-history.com/svg?repos=apache/incubator-hugegraph&type=Date)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, consider add the 2 charts in website/doc repo first? (statistic info could enhance later)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is reconcilable, put the 2 charts in the readme will be faster, the official website update is slower

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to upgrdae the hugegraph website with a new freamwork, the 2 charts can consider to put in new website. I am working for task 11

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is reconcilable, put the 2 charts in the readme will be faster, the official website update is slower

yep, but maybe we need listen the community voice (like a vote in discussion to choose what kind of chart we need show in the README), because it occupies a larger space

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I create a new discussion for this question.We can discuss this question in this discussion with the community.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@imbajin I delete these two controversial charts. After the community has conclusions, you can add it as according to the discussion. Do you think this is okay?

README.md Outdated Show resolved Hide resolved

Codecov Report

Merging #2227 (ff52f2f) into master (bcf2a39) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #2227      +/-   ##
============================================
- Coverage     65.03%   64.97%   -0.07%     
+ Complexity      977      484     -493     
============================================
  Files           498      498              
  Lines         40681    40681              
  Branches       5681     5681              
============================================
- Hits          26457    26432      -25     
- Misses        11597    11605       +8     
- Partials       2627     2644      +17

see 91 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

README.md Outdated Show resolved Hide resolved

		You are welcome to contribute to HugeGraph, and we are looking forward to working with you to build an excellent open source community.

		### Contact Us
		[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph)](https://github.com/apache/incubator-hugegraph/graphs/contributors)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wonder to know if we could reduce the size of this contri-graph? (like 50%?)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I change the size to take more small space

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I try it,but it seems too narrow，what do you think？What size it should be, normal size or small size ?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I try it,but it seems too narrow，what do you think？What size it should be, normal size or small size ?

if we can't choose middle/proper size, seems the normal size is better

Comment on lines +86 to +88

		<div align="center">
		<img src="https://github.com/apache/incubator-hugegraph-doc/blob/master/assets/images/wechat.png?raw=true" alt="QR png" width="300"/>
		</div>