Skip to content

Commit 6b0e6c0

Browse files
committed
docs: add Chinese README and update project description
- Add README_ZH.md with full Chinese translation - Update project description to reflect actual implementation - Add aqc-mcp to acknowledgments - Remove FAQ section - Add language switch links (EN/ZH)
1 parent baf96da commit 6b0e6c0

2 files changed

Lines changed: 354 additions & 31 deletions

File tree

README.md

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Astro CLI 🚀
22

3-
**[中文文档](README_ZH.md)** | **English**
3+
**[English](README.md)** | **[中文](README_ZH.md)** | **[日本語](README_JA.md)** | **[Français](README_FR.md)**
44

55
> Your gateway to cosmos — Query astronomical data from command line
66
@@ -13,7 +13,7 @@
1313

1414
## ✨ What is Astro CLI?
1515

16-
**Astro CLI** is a modern command-line tool that provides quick access to multiple astronomical data services through the [Astroquery](https://astroquery.readthedocs.io/) library. It's designed for astronomers, researchers, and anyone who needs to query astronomical databases efficiently from the terminal.
16+
**Astro CLI** is a modern command-line tool that provides quick access to multiple astronomical data services. It integrates [Astroquery](https://astroquery.readthedocs.io/) and other data access methods (direct API calls, HTTP requests) to help astronomers, researchers, and anyone query astronomical databases efficiently from the terminal.
1717

1818
*17 data sources. One command. Beautiful output. Multi-language support. Extensible for future services.*
1919

@@ -312,39 +312,13 @@ astrocli/
312312

313313
BSD 3-Clause License
314314

315-
This project uses [Astroquery](https://github.com/astropy/astroquery), which is licensed under the BSD 3-Clause License.
316-
317315
---
318316

319317
## 🙏 Acknowledgments
320318

321-
- [Astroquery](https://astroquery.readthedocs.io/) - Core library for astronomical data access
319+
- [aqc-mcp](https://github.com/inoribea/aqc-mcp) - MCP server for AI assistants
320+
- [Astroquery](https://astroquery.readthedocs.io/) - Astronomical data access library
322321
- [Typer](https://typer.tiangolo.com/) - Modern CLI framework
323322
- [Rich](https://github.com/Textualize/rich) - Beautiful terminal output
324323
- [AAVSO](https://www.aavso.org/) - American Association of Variable Star Observers
325-
- [Fermi Team](https://fermi.gsfc.nasa.gov/) - Fermi Gamma-ray Space Telescope
326-
327-
---
328-
329-
## 📝 FAQ
330-
331-
<details>
332-
<summary><b>Common Questions</b></summary>
333-
334-
### Can I use this without Node.js?
335-
336-
Yes! Install from source: `pip install -e .` or use Python directly after installing dependencies.
337-
338-
### How do I add a new data service?
339-
340-
See the [Development](#-development) section above. Most services in Astroquery can be wrapped with similar patterns.
341-
342-
### Why do some modules say "not fully implemented"?
343-
344-
Some advanced features or edge cases may not have full CLI coverage yet. Core query functionality works, but special parameters might need direct access to the underlying astroquery library.
345-
346-
### What's the difference between this and astroquery?
347-
348-
**Astro CLI** is a command-line interface for Astroquery. Think of it as a user-friendly wrapper that makes common tasks easier. It doesn't replace Astroquery — it enhances it!
349-
350-
</details>
324+
- [Fermi Team](https://fermi.gsfc.nasa.gov/) - Fermi Gamma-ray Space Telescope

0 commit comments

Comments
 (0)